Label
|
Field Type
|
Description and Potential Values
|
user
|
Text
|
The internal database name of a recipient or group and is the value referenced by the GetASCII, GetWeb, GetTAP and GetSerial interfaces.
For instance, this field name is the value referenced by network monitoring utilities, CAD dispatching, ticket tracking systems and similar.
|
full_name
|
Text
|
The recipient or group's display name in the PageGate GUI Client and in any messaging websites this recipient or group appears on.
|
id
|
Text
|
The ID to message. This will vary widely based on what type of messages this recipient will receive. It could be a 10 or 11 digit ID for SMS, it could be an email address, it could be a custom ID string or it could be something else entirely.
|
EmailTo
|
Text
|
When this recipient is messaged through SMTP based carriers, this is the email address that will be messaged. This field overrides what may be in the ID field but only for delivery via the SMTP protocol, otherwise the ID field is respected.
It is possible to tie a recipient to a non-SMTP method of delivery, like cellular hardware or an SMS delivery service (AWSSNS, Twilio, etc), then configure a failover scenario where that non-SMTP method of delivery fails over to SMTP. When that happens, this field's delivery value will be used instead of the id value.
|
carrier
|
Text
|
This value must exactly match the name of a carrier as it exists in the 'carrier' field of the Carriers table in the database; which is also the name displayed in the 'Carriers' section of PG Admin.
|
maxchars
|
Numeric
|
The maximum number of characters this recipient should have the ability to receive. This value may be higher than the carrier's 'Max Chars' value. If the recipient value is higher than the carrier value, PageGate will break up long messages in to multiple data blocks based on the carrier value.
|
on_call
|
Boolean
|
0 for False. -1 for True.
This field should be set to False for recipients.
If a group should have an on-call schedule, set this field to True. Schedules are configured in PG Admin or by modifying values in the table 'oncalltable' of the database.
|
reliapage_index
|
Numeric
|
Set this field to 0.
|
forward
|
Text
|
If you own the GetMail interface and would like a copy of all messages sent to this recipient or group forwarded to an email address, specify that email address in this field.
If you do not own the GetMail interface, leave this field as a blank string value.
|
ascii_service
|
Boolean
|
0 for False. -1 for True.
If GetAscii is part if your license, set to True. Otherwise, set to False.
|
gui_service
|
Boolean
|
0 for False. -1 for True.
If the PageGate GUI Client is part if your license, set to True. Otherwise, set to False.
|
mail_service
|
Boolean
|
0 for False. -1 for True.
If GetMail is part if your license, set to True. Otherwise, set to False.
|
serial_service
|
Boolean
|
0 for False. -1 for True.
If GetSerial is part if your license, set to True. Otherwise, set to False.
|
tap_service
|
Boolean
|
0 for False. -1 for True.
If GetTAP is part if your license, set to True. Otherwise, set to False.
|
web_service
|
Boolean
|
0 for False. -1 for True.
If GetWeb is part if your license, set to True. Otherwise, set to False.
|
ad_hoc
|
Boolean
|
0 for False. -1 for True.
This field should be set to False for groups.
If this recipient is an ad-hoc recipient, set to True. Otherwise, set to False.
|
multi_page
|
Boolean
|
0 for False. -1 for True.
This field should be set to False for recipients.
If this group is tied to the multi-page GetWeb template, set this to True. Otherwise, set to False.
|
email_only
|
Boolean
|
0 for False. -1 for True.
This field should be set to False for groups.
If this recipient should only exist as a mailbox for use with GetMail, set to True. Otherwise, set to False.
|
group
|
Boolean
|
0 for False. -1 for True.
This field should be set to False for recipients.
If this entry should be a group, set to True. Otherwise, set to False.
|
display_group
|
Boolean
|
0 for False. -1 for True.
This field should be set to False for recipients and groups.
If this entry should be a display group, set to True. Otherwise, set to False.
|
template
|
Text
|
Set to a blank string value.
|
text1 - text 10
|
Text
|
Text fields that are referenced by GetWeb's basic templates and values that may be called on by PageGate's template system. In most cases, leave these as blank string values.
|
image1 - image5
|
Text
|
Text fields that are referenced by GetWeb's basic templates and values that may be called on by PageGate's template system. In most cases, leave these as blank string values.
|
custom
|
Boolean
|
0 for False. -1 for True.
This field should be set to False for recipients.
If this group is tied to a custom web template, set to True. Otherwise, set to False.
|
group_list
|
Boolean
|
0 for False. -1 for True.
This field should be set to False for recipients.
If this group is tied to a web template and the members of this group should display on the website it generates, set to True. Otherwise, set to False.
|
GLFullName
|
Boolean
|
0 for False. -1 for True.
This field should be set to False for recipients.
If this group_list is true, setting this field to True will configure the website to reference the value in the full_name field instead of the recipient field.
In all other cases, set to False.
|
Failover
|
Text
|
This field may only be set for recipients and has no effect on groups.
The value of this field must exactly match the name of a recipient or group as it appears in the user field.
If messages to this recipient fail, they will be redirected to the specified value.
Otherwise, leave this field as a blank string value.
|
extra1 - extra4
|
Text
|
Text fields that are referenced by the PageGate GUI Client and values that may be called on by PageGate's template system.
In most cases, leave these as blank string values.
|
hold
|
Boolean
|
0 for False. -1 for True.
This field should be set to False for groups.
If this recipient should have a hold placed on their messages during specified dates and times, set to True and configure the values in hold_start and hold_stop.
In all other cases, set to False.
|
hold_start
|
Date/Time
|
If hold is set to True, enter the current date and what time the message hold should begin. If hold is set to False, enter the current date and time. The field value won't be referenced if hold is False but this field can't be left blank.
Date values should be expressed as m/dd/yyyy and Time values should be expressed as HH:MM:SS AM/PM.
Example: 7/16/2020 8:35:00 PM
The only part of the field that will remain relevant is the time value specified. PageGate will automatically update the date value to the current date if hold is True.
|
hold_stop
|
Date/Time
|
If hold is set to True, enter the current date and what time the message hold should end. If hold is set to False, enter the current date and time. The field value won't be referenced if hold is False but this field can't be left blank.
Date values should be expressed as m/dd/yyyy and Time values should be expressed as HH:MM:SS AM/PM.
Example: 7/16/2020 7:35:00 AM
The only part of the field that will remain relevant is the time value specified. PageGate will automatically update the date value to the current date if hold is True.
|
creator
|
Text
|
This field specifies the name of an administrator or administrative group that should have creator/control rights to this recipient or group. If you aren't using the security system, leave this field as a blank string value.
Otherwise, match this value to the name of an administrator or administrative group in your PageGate security list.
|
priority
|
Numeric
|
Set to 100 for groups.
Can be set to 1 - 32000 for recipients and reflects that recipient's priority in messaging. Recipients with values closer to 1 are sorted higher in the delivery order while recipients with values closer to 32000 are sorted lower. For more information, see Prioritizing Messages.
|