Skip to content
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.

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

Consistent Alarm naming convention between Alarm Table and Alarm Log Table #3242

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jeonghanlee
Copy link
Contributor

@shroffk and @kasemir

As we've discussed and agreed, here is the pull request to contain the consistent and meaningful naming convention within the Alarm Table and the Alarm Log Table.

Here is the table which we've developed so far.

Name Proposed Name Area
PV PV Alarm Table
Description Description Alarm Table
PV Severity PV Severity Alarm Table
PV Status PV Message Alarm Table
Alarm Severity Alarm Severity Alarm Table
Alarm Status Alarm Message Alarm Table
Alarm Time Alarm Time Alarm Table
Alarm Value Alarm Value Alarm Table
     
Config Config Alarm Log Table
PV PV Alarm Log Table
Severity Alarm Severity Alarm Log Table
Message Alarm Message Alarm Log Table
Time Alarm Time Alarm Log Table
Message Time Alarm Log Time Alarm Log Table
Current Severtiy PV Severity Alarm Log Table
Current Message PV Message Alarm Log Table
User User Alarm Log Table
Host Host Alarm Log Table
Value Alarm Value  
Time Delta Time Delta Alarm Log Table
Command Command Alarm Log Table
     
PV PV Alarm Log Table Search
Severity Alarm Severity Alarm Log Table Search
Message Alarm Message Alarm Log Table Search
Current Severity PV Severity Alarm Log Table Search
Current Message PV Message Alarm Log Table Search
User User Alarm Log Table Search
Time Alarm Log Time Alarm Log Table Search
Start Time Start Time Alarm Log Table Search
End Time End Time Alarm Log Table Search
Command Command Alarm Log Table Search

Please let me know what you think.

@shroffk we also have to work together to update the alarm documentation to reflect these changes.

Thanks,

@jeonghanlee, Soo Ryu, and @Sangil-Lee at ALS-U Controls, LBNL.

@shroffk
Copy link
Member

shroffk commented Jan 17, 2025

Broadly it looks good... and it is a great effort to standardize across these applications/services

Is there a reason to choose PV Message vs keeping it PV Status... is this to link it to the other instances where Current Message also maps to PV Message

PV Status PV Message Alarm Table

@jeonghanlee
Copy link
Contributor Author

We (You, Kay, and me) decided to use Message instead of Status to keep the modern EPICS convention which exists as far as I remember. Please correct me if I am wrong, since I am old and don't remember very well now. ;)

@jeonghanlee
Copy link
Contributor Author

1
2

@jeonghanlee
Copy link
Contributor Author

jeonghanlee commented Jan 18, 2025

@shroffk when I took the screen capture, I saw there is inconsistent. I didn't have much attention about the query itself. Can you check what kind of query strings will be changed due to the new naming convention?

I will work with Sang-il to check them independently also. And I converted this PR to the draft.

@jeonghanlee jeonghanlee marked this pull request as draft January 18, 2025 00:44
@jeonghanlee
Copy link
Contributor Author

@shroffk it turns out, we need to change all variable names between Alarm Server and Alarm Logger table within multiple java codes. We will come back after all relevant codes changes, and the corresponding tests.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants