Difference between revisions of "Application Settings"
Jump to navigation
Jump to search
(Created page with "The Application Settings setup page contains your system wide settings that determine how PTS functions. These settings should not be amended without a thorough understanding of what the setting does, or under guidance from TMSi staff. ==List of application settings== This is the complete list of application settings. <ul> <li><strong>ACTRPTSDIR - SSRS Subfolder containing PTS Activity Reports</strong><br/>SSRS Subfolder containing PTS Activity Reports</li> <li><strong>A...") |
|||
(3 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
The Application Settings setup page contains your system wide settings that determine how PTS functions. These settings should not be amended without a thorough understanding of what the setting does, or under guidance from TMSi staff. | The Application Settings setup page contains your system wide settings that determine how PTS functions. These settings should not be amended without a thorough understanding of what the setting does, or under guidance from TMSi staff. | ||
=List of application settings= | |||
This is the complete list of application settings. | This is the complete list of application settings. | ||
< | {| class="wikitable" | ||
!Key | |||
!Name | |||
< | !Description | ||
< | |- | ||
< | |<strong>ACTRPTSDIR</strong> | ||
< | |SSRS Subfolder containing PTS Activity Reports | ||
< | |SSRS Subfolder containing PTS Activity Reports | ||
< | |- | ||
|<strong>ACTRPTSURL</strong> | |||
< | |URL of SQL Reports Server for Activity Reports | ||
< | |URL of SQL Reports Server for Activity Reports. | ||
|- | |||
< | |<strong>ADCONTEXT</strong> | ||
|Context for AD Login | |||
< | |Context for handling AD Group auto-login. Valid values are DOMAIN or MACHINE. | ||
|- | |||
< | |<strong>ALLOWREG</strong> | ||
< | |Allow User Registration | ||
|Determines if Users can register themselves to access the system. | |||
|- | |||
|<strong>CDLICKEY</strong> | |||
< | |Licence Key for CD Register | ||
|Licence Key required for use of CD Register. | |||
< | |- | ||
|<strong>CDNEWROLE</strong> | |||
< | |Role assigned to new CD Register Users | ||
< | |Role Assigned to new CD Register Users when created by a User with CDCREATEUSER permission. | ||
< | |- | ||
|<strong>CDPATID</strong> | |||
< | |CD Register Patient Lookup ID Type | ||
< | |Use LOCAL or NATIONAL ID when looking up patient in CD Register. | ||
|- | |||
< | |<strong>CDRPTSDIR</strong> | ||
< | |SSRS Subfolder containing PTS CD Register Reports | ||
< | |SSRS Subfolder containing PTS Activity Reports | ||
< | |- | ||
< | |<strong>CDRPTSURL</strong> | ||
|URL of SQL Reports Server for CD Register Reports | |||
< | |URL of SQL Reports Server for CD Register Reports. | ||
< | |- | ||
< | |<strong>COMPANY</strong> | ||
|Name of Organisation | |||
< | |The Name of your organisation. | ||
|- | |||
|<strong>DEVLICKEY</strong> | |||
< | |Devices Licence Key | ||
< | |Key that controls the number of devices (iOS or Android) that are licensed for use with PTS. | ||
< | |- | ||
< | |<strong>DISPLICKEY</strong> | ||
|Dispensary Licence Key | |||
< | |Key that controls the number of dispensaries that are licensed to your organisation. | ||
|- | |||
|<strong>EMAILFROM</strong> | |||
< | |EMail From address | ||
|The EMail address that will appear in the FROM field. | |||
< | |- | ||
< | |<strong>EMAILPASS</strong> | ||
< | |EMAIL Password | ||
< | |The Password used to logon to the EMail Server. | ||
|- | |||
|<strong>EMAILPORT</strong> | |||
|EMAIL Port | |||
|The Port used by the EMail Server. | |||
|- | |||
|<strong>EMAILSERV</strong> | |||
|EMAIL Server | |||
|The name of the EMail Server. | |||
|- | |||
|<strong>EMAILSSL</strong> | |||
|EMail Requires SSL? | |||
|Determines if EMail server requires a SSL connection. | |||
|- | |||
|<strong>EMAILUSER</strong> | |||
|EMAIL Username | |||
|The Username used to logon to the EMail Server. | |||
|- | |||
|<strong>GETADDAPI</strong> | |||
|getAddress API Key | |||
|Your getAddress() API Key that is used when looking up addresses from their postcode. See https://getaddress.io/ for more information. | |||
|- | |||
|<strong>HL7RCVRS</strong> | |||
|HL7 Receivers | |||
|Hostnames, Ports and names of HL7 receivers listening for Prescription Status change messages. The list should be in the format HOSTNAME1;PORT1;APPNAME1:HOSTNAME2;PORT2;APPNAME2 | |||
|- | |||
|<strong>LOCALID</strong> | |||
|Local ID | |||
|The text that will be displayed for the local patient identifier. e.g. 'Hospital number'. | |||
|- | |||
|<strong>LOCALIDF</strong> | |||
|Format of Local ID | |||
|Format of Local ID. This allows prefix or suffix character to be added to Local IDs | |||
|- | |||
|<strong>LOCALIDQRY</strong> | |||
|LocalID Query | |||
|Query used by booking-in screen when searching for a patient using localID. PTS will look for the following field names returned by the query: NationalID, LocalID, Title, Forename, Familyname, Gender, Mobile, EMail, DOB, Address | |||
|- | |||
|<strong>MEDHOOK</strong> | |||
|Medpoint Webhook Secret | |||
|Medpoint Webhook Secret | |||
|- | |||
|<strong>MEDID</strong> | |||
|Medpoint Client ID | |||
|Medpoint API Client ID | |||
|- | |||
|<strong>MEDSEC</strong> | |||
|Medpoint Client Secret | |||
|Medpoint API Client Secret | |||
|- | |||
|<strong>MEDURL</strong> | |||
|Medpoint URL | |||
|Medpoint API URL | |||
|- | |||
|<strong>NATIDF</strong> | |||
|Format of National ID | |||
|Format of National ID. This allows prefix or suffix character to be added to National IDs | |||
|- | |||
|<strong>NATIDQRY</strong> | |||
|NationalID Query | |||
|Query used by booking-in screen when searching for a patient using nationalID. PTS will look for the following field names returned by the query: NationalID, LocalID, Title, Forename, Familyname, Gender, Mobile, EMail, DOB, Address | |||
|- | |||
|<strong>NATIONALID</strong> | |||
|National ID | |||
|The text that will be displayed for the national patient identifier. e.g. 'NHS number'. | |||
|- | |||
|<strong>OFFLINE</strong> | |||
|Skip checking if PTS is online | |||
|Setting this to True will skip checking if online to check licence etc. | |||
|- | |||
|<strong>PASDSNS</strong> | |||
|Patient Lookup DSNs | |||
|Patient Lookup DSNs | |||
|- | |||
|<strong>PRINTPASS</strong> | |||
|Password for Printing | |||
|The password of the user used for printing. | |||
|- | |||
|<strong>PRINTUSER</strong> | |||
|Domain User for Printing | |||
|The username used for printing. | |||
|- | |||
|<strong>PWDEXPIRY</strong> | |||
|No. of days until a users password expires | |||
|No. of days until password expires. Set to 0 to never expire. Not applicable if Security Mode is set to (W)indows) | |||
|- | |||
|<strong>PWDLENGTH</strong> | |||
|Minimum length of passwords | |||
|Minimum length of passwords | |||
|- | |||
|<strong>PWDREQDIG</strong> | |||
|Numeric characters required in password? | |||
|Numeric characters required in password? | |||
|- | |||
|<strong>PWDREQLOW</strong> | |||
|Lowercase characters required in password? | |||
|Lowercase characters required in password? | |||
|- | |||
|<strong>PWDREQNON</strong> | |||
|Non alphanumeric characters required in password? | |||
|Non alphanumeric characters required in password? | |||
|- | |||
|<strong>PWDREQUPP</strong> | |||
|Uppercase characters required in password? | |||
|Uppercase characters required in password? | |||
|- | |||
|<strong>PWDREUSE</strong> | |||
|Allow reuse of previous passwords? | |||
|Allow reuse of previous passwords? | |||
|- | |||
|<strong>REGCB</strong> | |||
|Registration - Confirmation Body | |||
|Body of the E-Mail that is sent when a Registration is confirmed. {0} is replaced by the name of the user, {1} is replaced by the URL to access PTS, {2} is replaced by the username of the PTS user that was added and {3} is replaced by the E-Mail address the user used when they registered. | |||
|- | |||
|<strong>REGCS</strong> | |||
|Registration - Confirmation Subject | |||
|Subject of E-Mail sent when registration is confirmed. | |||
|- | |||
|<strong>REGDB</strong> | |||
|Registration - Denial Body | |||
|The Body of the E-Mail that is sent when a registration request is denied. {0} is replaced by the name of the user and {1} is replaced by the contact details for the Dispensary. | |||
|- | |||
|<strong>REGDS</strong> | |||
|Registration - Denial Subject | |||
|The Subject of the E-Mail that is sent when a registration request is denied. | |||
|- | |||
|<strong>REGOUB</strong> | |||
|Registration - Allocate To Other User Body | |||
|Body of E-Mail sent when AD Username is allocated to an existing PTS user.{0} is replaced by the name of the user, {1} is replaced by the URL to access PTS, {2} is replaced by the AD Username, {3} is replaced by the name of the PTS user that the username was added to and {4} is replaced by the contact details for the Dispensary. | |||
|- | |||
|<strong>REGOUS</strong> | |||
|Registration - Allocate To Other User Subject | |||
|Subject of E-Mail sent when AD Username is allocated to an existing PTS user | |||
|- | |||
|<strong>REPORTMAX</strong> | |||
|Max no. of records returned on reports | |||
|The maximum number of records that will be returned by the search and reports screen. | |||
|- | |||
|<strong>REPORTSDIR</strong> | |||
|SSRS Subfolder containing PTS Reports | |||
|SSRS Subfolder containing PTS Reports | |||
|- | |||
|<strong>REPORTSDOM</strong> | |||
|SSRS Reports Service Domain | |||
|SSRS Reports Service Domain | |||
|- | |||
|<strong>REPORTSLST</strong> | |||
|URL of SQL Reports Service | |||
|URL of SQL Reports Web Service to retrieve list of reports | |||
|- | |||
|<strong>REPORTSPWD</strong> | |||
|SSRS Reports Service Password | |||
|SSRS Reports Service Password | |||
|- | |||
|<strong>REPORTSURL</strong> | |||
|URL of SQL Reports Server | |||
|URL of SQL Reports Server. | |||
|- | |||
|<strong>REPORTSUSR</strong> | |||
|SSRS Reports Service User | |||
|SSRS Reports Service User (Windows Domain User) | |||
|- | |||
|<strong>REPORTSVER</strong> | |||
|Version of SSRS | |||
|Which version of SQL Reports Server | |||
|- | |||
|<strong>SCANLICKEY</strong> | |||
|Scanners Licence Key | |||
|Key that controls the number of barcode scanners (iOS or Android) that are licensed for use with PTS. | |||
|- | |||
|<strong>SECMODE</strong> | |||
|Security Mode | |||
|The mode of security used. This can be (W)indows only, (P)TS only, (M)ixed Windows/PTS, (AD) Active Directory, (MAD) Mixed AD/PTS | |||
|- | |||
|<strong>SMSAPIID</strong> | |||
|SMS API ID | |||
|The API_ID for the SMS API. | |||
|- | |||
|<strong>SMSPASS</strong> | |||
|SMS Password | |||
|The Password for the SMS API. | |||
|- | |||
|<strong>SMSTYPE</strong> | |||
|SMS Provider | |||
|The provider of the SMS Service (Clickatell or Soprano). | |||
|- | |||
|<strong>SMSURL</strong> | |||
|URL of SMS Service | |||
|The URL of the API that handles SMS Messaging. | |||
|- | |||
|<strong>SMSUSER</strong> | |||
|SMS UserName | |||
|The Username for the SMS API. | |||
|- | |||
|<strong>STATUSURL</strong> | |||
|URL of Status Check Website | |||
|URL of Website that will allow patient to check status of their Prescription. The Prescription ID will be appended to this URL so it usually ends with ?PrescriptionId= | |||
|- | |||
|<strong>SUPPORTID</strong> | |||
|TMSi Support System ID | |||
|Your organisations Id on the support system at TMSInsight.com | |||
|- | |||
|<strong>URL</strong> | |||
|URL of PTS Application | |||
|URL of Main PTS application. | |||
|- | |||
|<strong>VERBOSELOG</strong> | |||
|Verbose Logging? | |||
|Determines if PTS writes verbose messages to the ELMAH Error Log. | |||
|} |
Latest revision as of 11:27, 7 September 2023
The Application Settings setup page contains your system wide settings that determine how PTS functions. These settings should not be amended without a thorough understanding of what the setting does, or under guidance from TMSi staff.
List of application settings
This is the complete list of application settings.
Key | Name | Description |
---|---|---|
ACTRPTSDIR | SSRS Subfolder containing PTS Activity Reports | SSRS Subfolder containing PTS Activity Reports |
ACTRPTSURL | URL of SQL Reports Server for Activity Reports | URL of SQL Reports Server for Activity Reports. |
ADCONTEXT | Context for AD Login | Context for handling AD Group auto-login. Valid values are DOMAIN or MACHINE. |
ALLOWREG | Allow User Registration | Determines if Users can register themselves to access the system. |
CDLICKEY | Licence Key for CD Register | Licence Key required for use of CD Register. |
CDNEWROLE | Role assigned to new CD Register Users | Role Assigned to new CD Register Users when created by a User with CDCREATEUSER permission. |
CDPATID | CD Register Patient Lookup ID Type | Use LOCAL or NATIONAL ID when looking up patient in CD Register. |
CDRPTSDIR | SSRS Subfolder containing PTS CD Register Reports | SSRS Subfolder containing PTS Activity Reports |
CDRPTSURL | URL of SQL Reports Server for CD Register Reports | URL of SQL Reports Server for CD Register Reports. |
COMPANY | Name of Organisation | The Name of your organisation. |
DEVLICKEY | Devices Licence Key | Key that controls the number of devices (iOS or Android) that are licensed for use with PTS. |
DISPLICKEY | Dispensary Licence Key | Key that controls the number of dispensaries that are licensed to your organisation. |
EMAILFROM | EMail From address | The EMail address that will appear in the FROM field. |
EMAILPASS | EMAIL Password | The Password used to logon to the EMail Server. |
EMAILPORT | EMAIL Port | The Port used by the EMail Server. |
EMAILSERV | EMAIL Server | The name of the EMail Server. |
EMAILSSL | EMail Requires SSL? | Determines if EMail server requires a SSL connection. |
EMAILUSER | EMAIL Username | The Username used to logon to the EMail Server. |
GETADDAPI | getAddress API Key | Your getAddress() API Key that is used when looking up addresses from their postcode. See https://getaddress.io/ for more information. |
HL7RCVRS | HL7 Receivers | Hostnames, Ports and names of HL7 receivers listening for Prescription Status change messages. The list should be in the format HOSTNAME1;PORT1;APPNAME1:HOSTNAME2;PORT2;APPNAME2 |
LOCALID | Local ID | The text that will be displayed for the local patient identifier. e.g. 'Hospital number'. |
LOCALIDF | Format of Local ID | Format of Local ID. This allows prefix or suffix character to be added to Local IDs |
LOCALIDQRY | LocalID Query | Query used by booking-in screen when searching for a patient using localID. PTS will look for the following field names returned by the query: NationalID, LocalID, Title, Forename, Familyname, Gender, Mobile, EMail, DOB, Address |
MEDHOOK | Medpoint Webhook Secret | Medpoint Webhook Secret |
MEDID | Medpoint Client ID | Medpoint API Client ID |
MEDSEC | Medpoint Client Secret | Medpoint API Client Secret |
MEDURL | Medpoint URL | Medpoint API URL |
NATIDF | Format of National ID | Format of National ID. This allows prefix or suffix character to be added to National IDs |
NATIDQRY | NationalID Query | Query used by booking-in screen when searching for a patient using nationalID. PTS will look for the following field names returned by the query: NationalID, LocalID, Title, Forename, Familyname, Gender, Mobile, EMail, DOB, Address |
NATIONALID | National ID | The text that will be displayed for the national patient identifier. e.g. 'NHS number'. |
OFFLINE | Skip checking if PTS is online | Setting this to True will skip checking if online to check licence etc. |
PASDSNS | Patient Lookup DSNs | Patient Lookup DSNs |
PRINTPASS | Password for Printing | The password of the user used for printing. |
PRINTUSER | Domain User for Printing | The username used for printing. |
PWDEXPIRY | No. of days until a users password expires | No. of days until password expires. Set to 0 to never expire. Not applicable if Security Mode is set to (W)indows) |
PWDLENGTH | Minimum length of passwords | Minimum length of passwords |
PWDREQDIG | Numeric characters required in password? | Numeric characters required in password? |
PWDREQLOW | Lowercase characters required in password? | Lowercase characters required in password? |
PWDREQNON | Non alphanumeric characters required in password? | Non alphanumeric characters required in password? |
PWDREQUPP | Uppercase characters required in password? | Uppercase characters required in password? |
PWDREUSE | Allow reuse of previous passwords? | Allow reuse of previous passwords? |
REGCB | Registration - Confirmation Body | Body of the E-Mail that is sent when a Registration is confirmed. {0} is replaced by the name of the user, {1} is replaced by the URL to access PTS, {2} is replaced by the username of the PTS user that was added and {3} is replaced by the E-Mail address the user used when they registered. |
REGCS | Registration - Confirmation Subject | Subject of E-Mail sent when registration is confirmed. |
REGDB | Registration - Denial Body | The Body of the E-Mail that is sent when a registration request is denied. {0} is replaced by the name of the user and {1} is replaced by the contact details for the Dispensary. |
REGDS | Registration - Denial Subject | The Subject of the E-Mail that is sent when a registration request is denied. |
REGOUB | Registration - Allocate To Other User Body | Body of E-Mail sent when AD Username is allocated to an existing PTS user.{0} is replaced by the name of the user, {1} is replaced by the URL to access PTS, {2} is replaced by the AD Username, {3} is replaced by the name of the PTS user that the username was added to and {4} is replaced by the contact details for the Dispensary. |
REGOUS | Registration - Allocate To Other User Subject | Subject of E-Mail sent when AD Username is allocated to an existing PTS user |
REPORTMAX | Max no. of records returned on reports | The maximum number of records that will be returned by the search and reports screen. |
REPORTSDIR | SSRS Subfolder containing PTS Reports | SSRS Subfolder containing PTS Reports |
REPORTSDOM | SSRS Reports Service Domain | SSRS Reports Service Domain |
REPORTSLST | URL of SQL Reports Service | URL of SQL Reports Web Service to retrieve list of reports |
REPORTSPWD | SSRS Reports Service Password | SSRS Reports Service Password |
REPORTSURL | URL of SQL Reports Server | URL of SQL Reports Server. |
REPORTSUSR | SSRS Reports Service User | SSRS Reports Service User (Windows Domain User) |
REPORTSVER | Version of SSRS | Which version of SQL Reports Server |
SCANLICKEY | Scanners Licence Key | Key that controls the number of barcode scanners (iOS or Android) that are licensed for use with PTS. |
SECMODE | Security Mode | The mode of security used. This can be (W)indows only, (P)TS only, (M)ixed Windows/PTS, (AD) Active Directory, (MAD) Mixed AD/PTS |
SMSAPIID | SMS API ID | The API_ID for the SMS API. |
SMSPASS | SMS Password | The Password for the SMS API. |
SMSTYPE | SMS Provider | The provider of the SMS Service (Clickatell or Soprano). |
SMSURL | URL of SMS Service | The URL of the API that handles SMS Messaging. |
SMSUSER | SMS UserName | The Username for the SMS API. |
STATUSURL | URL of Status Check Website | URL of Website that will allow patient to check status of their Prescription. The Prescription ID will be appended to this URL so it usually ends with ?PrescriptionId= |
SUPPORTID | TMSi Support System ID | Your organisations Id on the support system at TMSInsight.com |
URL | URL of PTS Application | URL of Main PTS application. |
VERBOSELOG | Verbose Logging? | Determines if PTS writes verbose messages to the ELMAH Error Log. |