Skip to content

Update alias, recordType, recordDesc, and iocConnectionInfo settings to be booleans #110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tynanford merged 1 commit into from
Jun 19, 2025
Merged

Update alias, recordType, recordDesc, and iocConnectionInfo settings to be booleans #110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions server/demo.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,16 +69,16 @@
#infotags = archive foo bar blah

# Uncomment line below to turn off the feature to add CA/PVA port info for name server to channelfinder
#iocConnectionInfo = off
#iocConnectionInfo = False

# Uncomment line below to turn on the feature to add alias records to channelfinder
#alias = on
#alias = True

# Uncomment line below to turn on the feature to add EPICS record type to channelfinder
#recordType = on
#recordType = True

# Uncomment line below to turn on the feature to add description field to channelfinder
#recordDesc = on
#recordDesc = True

# The size limit for finding channels (ie the value of the '~size' query parameter)
# If not specified then the fallback is the server default
Expand Down
6 changes: 3 additions & 3 deletions server/docker/config/cf1.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ infotags = archive
#environment_vars=ENGINEER:Engineer,EPICS_BASE:EpicsVersion,PWD:WorkingDirectory

# Turn on optional alias and recordType properties
alias = on
recordType = on
recordDesc = on
alias = True
recordType = True
recordDesc = True

# Mark all channels as 'Inactive' when processor is started (default: True)
cleanOnStart = True
Expand Down
6 changes: 3 additions & 3 deletions server/docker/config/cf2.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ loglevel=DEBUG
# and defining the corresponding PropertyName
#environment_vars=ENGINEER:Engineer,EPICS_BASE:EpicsVersion,PWD:WorkingDirectory
# Turn on optional alias and recordType properties
alias = on
recordType = on
recordDesc = on
alias = True
recordType = True
recordDesc = True

# Mark all channels as 'Inactive' when processor is stopped (default: True)
#cleanOnStop = True
Expand Down
31 changes: 16 additions & 15 deletions server/recceiver/cfstore.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,9 @@ def _startServiceWithLock(self):
RECCEIVERID_KEY,
}

if self.conf.get("alias"):
if self.conf.getboolean("alias"):
required_properties.add("alias")
if self.conf.get("recordType"):
if self.conf.getboolean("recordType"):
required_properties.add("recordType")
env_vars_setting = self.conf.get("environment_vars")
self.env_vars = {}
Expand All @@ -101,7 +101,8 @@ def _startServiceWithLock(self):
required_properties.add(cf_prop_name)
# Standard property names for CA/PVA name server connections. These are
# environment variables from reccaster so take advantage of env_vars
if self.conf.get("iocConnectionInfo"):
# iocConnectionInfo enabled by default
if self.conf.getboolean("iocConnectionInfo", True):
self.env_vars["RSRV_SERVER_PORT"] = "caPort"
self.env_vars["PVAS_SERVER_PORT"] = "pvaPort"
required_properties.add("caPort")
Expand All @@ -111,7 +112,7 @@ def _startServiceWithLock(self):
record_property_names_list = [s.strip(", ") for s in infotags_whitelist.split()]
else:
record_property_names_list = []
if self.conf.get("recordDesc"):
if self.conf.getboolean("recordDesc"):
record_property_names_list.append("recordDesc")
# Are any required properties not already present on CF?
properties = required_properties - set(cf_properties)
Expand Down Expand Up @@ -219,7 +220,7 @@ def _commitWithThread(self, transaction):
recordInfo = {}
for record_id, (record_name, record_type) in transaction.records_to_add.items():
recordInfo[record_id] = {"pvName": record_name}
if self.conf.get("recordType"):
if self.conf.getboolean("recordType"):
recordInfo[record_id]["recordType"] = record_type
for record_id, (record_infos_to_add) in transaction.record_infos_to_add.items():
# find intersection of these sets
Expand Down Expand Up @@ -293,7 +294,7 @@ def _commitWithThread(self, transaction):
self.channel_dict[record_name].append(iocid)
self.iocs[iocid]["channelcount"] += 1
"""In case, alias exists"""
if self.conf.get("alias"):
if self.conf.getboolean("alias"):
if record_name in recordInfoByName and "aliases" in recordInfoByName[record_name]:
for alias in recordInfoByName[record_name]["aliases"]:
self.channel_dict[alias].append(iocid) # add iocname to pvName in dict
Expand All @@ -302,7 +303,7 @@ def _commitWithThread(self, transaction):
if iocid in self.channel_dict[record_name]:
self.remove_channel(record_name, iocid)
"""In case, alias exists"""
if self.conf.get("alias"):
if self.conf.getboolean("alias"):
if record_name in recordInfoByName and "aliases" in recordInfoByName[record_name]:
for alias in recordInfoByName[record_name]["aliases"]:
self.remove_channel(alias, iocid)
Expand Down Expand Up @@ -496,7 +497,7 @@ def __updateCF__(
cf_channel,
processor.managed_properties,
)
if conf.get("recordType"):
if conf.getboolean("recordType"):
cf_channel["properties"] = __merge_property_lists(
cf_channel["properties"].append(
create_recordType_property(
Expand All @@ -509,7 +510,7 @@ def __updateCF__(
channels.append(cf_channel)
_log.debug("Add existing channel to previous IOC: {s}".format(s=channels[-1]))
"""In case alias exist, also delete them"""
if conf.get("alias"):
if conf.getboolean("alias"):
if cf_channel["name"] in recordInfoByName and "aliases" in recordInfoByName[cf_channel["name"]]:
for alias in recordInfoByName[cf_channel["name"]]["aliases"]:
if alias["name"] in channels_dict:
Expand All @@ -526,7 +527,7 @@ def __updateCF__(
alias,
processor.managed_properties,
)
if conf.get("recordType"):
if conf.getboolean("recordType"):
cf_channel["properties"] = __merge_property_lists(
cf_channel["properties"].append(
create_recordType_property(
Expand All @@ -552,7 +553,7 @@ def __updateCF__(
channels.append(cf_channel)
_log.debug("Add orphaned channel with no IOC: {s}".format(s=channels[-1]))
"""Also orphan any alias"""
if conf.get("alias"):
if conf.getboolean("alias"):
if cf_channel["name"] in recordInfoByName and "aliases" in recordInfoByName[cf_channel["name"]]:
for alias in recordInfoByName[cf_channel["name"]]["aliases"]:
alias["properties"] = __merge_property_lists(
Expand Down Expand Up @@ -588,7 +589,7 @@ def __updateCF__(
new_channels.remove(cf_channel["name"])

"""In case, alias exist"""
if conf.get("alias"):
if conf.getboolean("alias"):
if cf_channel["name"] in recordInfoByName and "aliases" in recordInfoByName[cf_channel["name"]]:
for alias in recordInfoByName[cf_channel["name"]]["aliases"]:
if alias in old_channels:
Expand Down Expand Up @@ -656,7 +657,7 @@ def __updateCF__(

for channel_name in new_channels:
newProps = create_properties(owner, iocTime, recceiverid, hostName, iocName, iocIP, iocid)
if conf.get("recordType"):
if conf.getboolean("recordType"):
newProps.append(create_recordType_property(owner, recordInfoByName[channel_name]["recordType"]))
if channel_name in recordInfoByName and "infoProperties" in recordInfoByName[channel_name]:
newProps = newProps + recordInfoByName[channel_name]["infoProperties"]
Expand All @@ -675,7 +676,7 @@ def __updateCF__(
channels.append(existingChannel)
_log.debug("Add existing channel with different IOC: {s}".format(s=channels[-1]))
"""in case, alias exists, update their properties too"""
if conf.get("alias"):
if conf.getboolean("alias"):
if channel_name in recordInfoByName and "aliases" in recordInfoByName[channel_name]:
alProps = [create_alias_property(owner, channel_name)]
for p in newProps:
Expand All @@ -697,7 +698,7 @@ def __updateCF__(
"""New channel"""
channels.append({"name": channel_name, "owner": owner, "properties": newProps})
_log.debug("Add new channel: {s}".format(s=channels[-1]))
if conf.get("alias"):
if conf.getboolean("alias"):
if channel_name in recordInfoByName and "aliases" in recordInfoByName[channel_name]:
alProps = [create_alias_property(owner, channel_name)]
for p in newProps:
Expand Down
8 changes: 4 additions & 4 deletions server/recceiver_full.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,16 +65,16 @@ idkey = 42
infotags = archive

# Feature to add CA/PVA port info for name server to channelfinder
iocConnectionInfo = on
iocConnectionInfo = True

# Add alias records to channelfinder
alias = on
alias = True

# Add EPICS record type to channelfinder
recordType = on
recordType = True

# Add description field to channelfinder
recordDesc = on
recordDesc = True

# The size limit for finding channels (ie the value of the '~size' query parameter)
# If not specified then the fallback is the server default
Expand Down