9 February 2010
29 January 2010
28 January 2010
The EMOS eClient has been designed as a tray icon application, it retrieves the data from the Pharos EDI. The only settings held on the client are connection settings for the EDI server. The settings for the application are held in the Network Terminal record in Pharos using the Pharos ini_schema architecture.
When the application launches it attempts to connect to the specified Pharos EDi server and loads its settings. If the Account Summary on Icon mouse hover is enabled then moving the mouse over the icon causes the Account Summary display to be shown for a period of Balloontip timeout.If the Account Info on Icon left click is enabled then Left clicking the tray icon produces a Balloon tip showing the Account Display prompt with the placeholders replaced. Otherwise the user information can shown by right clicking the icon and selecting the My Account Prompt from the drop down menu. This information is shown in a messagebox or eClient Form depending upon the setting.
Selecting the My Transactions Prompt brings up an additional window with the start and end date options that the user can search for their own transactions. In this window the user can also export the transactions or print the transactions if the options are enabled in the Network Terminal record.
The EMOS eClient requires
The Pharos ini_schema for the EMOS eClient needs to be added to the system, the mechanism for doing this is different for v7.2 and v8.0-v8.1
Install the client from the MSI. Once installed launch the eClient.exe from the install location (default: c:\Progeam Files\Emos\eClient).
The first time the eClient is run it creates the registry entries in HKLM\Software\EMOS\Common\PEdi. The application should detect that registry entries have been created and run the setup screen. Enter the URL for the pedi.asmx page on the edi server and enter the Edi sitecode (password). Enter the name of the Network Terminal as entered in the Server installation. Click Verify to check the settings.
The Sitecode is held encrypted in the registry and can only be written encrypted to the registry using the setup form.
Access to the setup form can be restricted by turning the Setup Menu Option to No in the Network Terminal record in Pharos Administrator.
These are the properties that are available in Pharos Administrator when a Network Terminal is inserted of the EMOS eClient Type. Advanced Type parameters are only visible when the Show Advanced Properties is enabled in Pharos Administrator. Hidden parameters are only available in the ini_schema and should be updated BEFORE the ini_schema is inserted into Pharos.
|AutoRun at Startup||Standard - Boolean||Yes/No||If this option is set the application will add an entry to the registry to launch the application on startup. HKLM\Software\Microsoft\CurrentVersion\Run\EMOS eClient.|
|Account Info on Icon Left Click||Standard - Boolean||Yes/No||This option allows the user to left click the tray icon to obtain their balance information in a Balloon tip. However, if the network speed is not quick enough the icon can display "Server offline" messages before it has returned the data from the EDI. It is much better to turn this option off and allow the user to select the Pharos Account option from the Right click Menu of the Tray icon.|
|Account Summary on Icon Mouse Hover||Standard - Boolean||Yes/No||This option allows the user to hover the mouse over the tray icon to obtain their balance summary information.|
|Account Menu Option||Standard - Boolean||Yes/No||Whether the User Account Information is available from the right click menu of the tray icon. The users account information is formated as per the Account Display settings and shown in a messagebox.|
|Transaction Menu Option||Standard - Boolean||Yes/No||Whether the Users Transaction information is available from the right click menu of the tray icon.|
|Setup Menu Option||Standard - Boolean||Yes/No||Whether the option to launch the setup form is available from the right click menu of the tray icon.|
|Quit Menu Option||Standard - Boolean||Yes/No||Whether the option to close the eClient application is available from the right click menu of the tray icon.|
|My Account Prompt||Standard - String||MaxLen=64, AllowBlank=false||The prompt which is shown on the right click menu for accessing the users account information. Prompt is also used as the title for the Account Information Window and account information balloon tip.|
|My Transactions Prompt||Standard - String||MaxLen=64, AllowBlank=false||The prompt which is shown on the right click menu for accessing the users transactions. Prompt is also used as the title for the transaction window.|
|Settings Prompt||Standard - String||MaxLen=64, AllowBlank=false||The prompt which is shown on the right click menu for accessing the settings.|
|Exit Prompt||Standard - String||MaxLen=64, AllowBlank=false||The prompt which is shown on the right click menu for exiting the application.|
|About Prompt||Hidden - String||MaxLen=64, AllowBlank=false||The prompt which is shown on the right click menu for About Information.|
|Account Summary Display||Standard - String||MaxLen=512, AllowBlank=false||The message that is shown to the user in the account summary tooltip. Uses UserDetails Placeholders to display returned user information.|
|Account Info Display||Standard - String||MaxLen=512, AllowBlank=false||The message that is shown to the user in the account information window and balloon tool tip. Uses UserDetails Placeholders to display returned user information.|
|BalloonTip Timeout||Standard - Integer||Min=1, Max=1000000||The time in milliseconds that the Balloon tip and Account Summary tooltip is shown|
|Account Info Window Type||Standard - Combobox||Windows Message Box, eClient Window||The type of window that is used to display the Account Information|
|Fade||Standard - Boolean||Yes/No||Whether the windows fade in and out.|
|Fade Speed||Standard - Integer||Min=1, Max=50||The speed at which the fade effect occurs, min =1 (slowest), max=50 (fastest).|
|Account Summary Offset X||Advanced - Integer||min=0, max=50||The x offset at which the account summary window is shown from the top of the right hand side of the taskbar.|
|Account Summary Offset Y||Advanced - Integer||min=0, max=50||The y offset at which the account summary window is shown from the top of the right hand side of the taskbar.|
|Server Offline||Standard - String||MaxLen=64, AllowBlank=false||The message that is displayed if the EDi server cannot be contacted.|
|Server Connecting||Standard - String||MaxLen=64, AllowBlank=false||The message that is displayed when the application is attempting to contact the EDi server.|
|Server Online||Standard - String||MaxLen=64, AllowBlank=false||The message that is displayed when the application is connected to the EDi|
|Allow Print Transactions||Standard - Boolean||Yes/No||Whether the Print option is available in the transction window.|
|Allow Save Transactions||Standard - Boolean||Yes/No||Whether the Save option is available in the transction window.|
|Default Difference between dates (days)||Standard - Integer||Min=1, Max=90||The difference between the start and end date when the transaction window loads.|
|Maximum Difference between dates (days)||Standard - Integer||Min=1, Max=365||The maximum diference allowed between the start and end date when searching for transactions.|
|Remember Column Widths||Standard - Boolean||Yes/No||Whether the application should remember the widths of the transaction columns if they are changed.|
|Default Column Width||Standard - Integer||Min=0, Max=130||The default width of the listview columns if remember column widths isn't used.|
|No Transactions prompt||Standard - String||MaxLen=512, AllowBlank=false||Prompt that is displayed when no transactions are returned. Uses prompts placeholders|
|Exceed Max Dates Prompt||Standard - String||MaxLen=512, AllowBlank=false||Prompt that is displayed when the end date is greater than Maximum Difference Between Dates from the start date. Uses prompts placeholders|
|Start After End Prompt||Standard - String||MaxLen=512, AllowBlank=false||Prompt that is displayed when the start date is greater than the end date. Uses prompts placeholders|
|Transactions SQL Query||Advanced - String||MaxLen=512, AllowBlank=false||Query that is run against database to return transactions. Uses prompts placeholders|
|Columns to display||Standard - String||MaxLen=512, AllowBlank=true/td>||Comma seperated list of the names of the transaction columns that are returned by the SQL Query to display in the transaction listview.|
|Columns to format as Currency||Standard - String||MaxLen=512, AllowBlank=true||Comma seperated list of the names of the columns to format as currency. Columns must be in the Columns to Display|
|Columns to format as Date||Standard - String||MaxLen=512, AllowBlank=true||Comma seperated list of the names of the columns to format as Date format. Columns must be in the Columns to Display|
|Date Format||Standard - String||MaxLen=64, AllowBlank=true||The format of the date string. The Application trys to convert the returned date into a DateTime object and if successful formats the date using .Nets Custom date and Time Formating. If the conversion to a DateTime object is unsuccessful then the date is shown as it was returned from the database.|
Place holders are used in the prompts and messages to be replaced by user details and configuration data.
|User Details PlaceHolders|
|%U||The logon username.|
|%B||The total balance of the 3 purses|
|%G||The users group name|
|%A||The users active Status|
|%D||The users Alias|
|%C||The users card id|
|%H||The users email address|
|%J||The users custom1 field|
|%K||The users custom2 field|
|%N||Whether the user can print colour|
|%P1||The value of the users technology purse (purse 1)|
|%P2||The value of the users tuition purse (purse 2)|
|%P3||The value of the users user pays purse (purse 3)|
|Prompts and SQL Query PlaceHolders|
|%S||The start date that was entered in the Startdate field.|
|%E||The end date that was entered in the Enddate field.|
|%M||The value of the Max difference days configuration option|
|%U||The username obtained from the logged on user.|
Transactions can be exported from the Transaction window as long as the Save Transactions option is set to yes in the Network Terminal Record.
The transactions can be exported as either a HTML format file or a Comma seperated list file. The HTML export uses a reporttemplate.html file which is
located in the installation folder. This can be customised to suit requirements. The HTML report template uses 4 placeholders,
%t = Report Title,
%h = Report parameters,
%g = Report summary,
%r = html table version of the transactions in the listview.