Rule Name | Valid Values | Description |
|---|---|---|
AutoTransitionSCADASteps | true/false | This parameter defines whether instructed actions sent to SCADA should automatically complete the initiating switching step when the SCADA action is complete. Product has this value set to true. |
BroadcastIntervalForUpdates | Number Value | This parameter defines how long (in seconds) the server will gather sheet and safety document updates before broadcasting those updates to the clients. The longer the time period, the better your performance will be, but also the longer the users may have to wait for updates to occur within the Switching Sheet List and Safety Document List. The time specified here is the maximum amount of time the users would have to wait for an update. By default, this parameter will be set to 15 seconds. If a value of 0 is specified, then no broadcasts will occur and the lists will rely on manual refreshes by users. Unless disabled, the minimum value is 5 (seconds); therefore, if the number value is less than 5, it will be converted to 5. |
BroadcastSafetyListeners | String Value | A list of tools or adapters that should get safety document updates. If this parameter is not specified, then "SafetyList" is used by default. If your project has an adapter that wants to listen for safety document updates, then that adapter's name needs to be added to this list delimited by a "+" sign. Example: SafetyList+MySafetyAdapter+MyOtherSafetyAdapter See the Web Switching and Web Safety Notifications chapter in the Oracle Utilities Network Management System Adapters Guide for more details. |
BroadcastSwitchingListeners | String Value | A list of tools or adapters that should get switching sheet updates. If this parameter is not specified, then "SwitchingList" is used by default. If your project has an adapter that wants to listen for switching sheet updates, then that adapter's name needs to be added to this list delimited by a "+" sign. Example: SwitchingList+MyAdapter+MyOtherAdapter See the Web Switching and Web Safety Notifications chapter in the Oracle Utilities Network Management System Adapters Guide for more details. |
CrewFieldName | String - Crew Field | Allows projects to specify what crew field to display in the various crew related fields found in Web Switching and Web Safety. The Crew field to use when populating the switching step, switching audit logs, safety audit logs and event log step entries pertaining to crews. Possible valid values include: contact, crewName, crewType, comments, custom1, and custom2. Only one of the possible values can be specified. Leaving this property blank will result in the value defaulting to crewName. |
DisableVersioning | true/false | Set this to true when you want to disable all versioning for the switching sheets. A "force" parameter can be used to force the checking in and incrementing of the sheet's version in the command calls to CheckInSheetVersionCommand and IncrementVersionCommand in required places if the global versioning is disabled. By default this option is set to false. |
JSON_EXPORT.clear_fields | String Value | Comma delimited list of fields that should be cleared from the JSON data structure before it is written to the file. For instance to clear an extension value for the sheet specify "extensions.Voltage". To clear a step extension field, specify "steps.extensions.details". You will need to look at the JSON data to determine the structure of the field name. Safety document data is found within the "safetyDocuments" attribute. The "metadata" attributes in the file should be left alone. |
JSON_IMPORT.clear_fields | String Value | Comma delimited list of fields that should be cleared from the JSON data structure before it is imported into NMS. For instance to clear an extension value for the sheet specify "extensions.Voltage". To clear a step extension field, specify "steps.extensions.details". You will need to look at the JSON data to determine the structure of the field name. Safety document data is found within the "safetyDocuments" attribute. The "metadata" attributes in the file should be left alone. They are used to generate an audit log entry for the imported switching sheet. |
JSON_EXPORT_IMPORT.limit | Number Value | The maximum number of switching sheets that can be imported or exported in one batch request. |
JSON_EXPORT_IMPORT.objectLockName | String Value | The name given to the single user lock entry when an export or import operation is under way. This lock keeps multiple users from initiating batch import or export operations at the same time. |
LOADED_SHEETS_LIMIT | Number Value | This is the maximum number of sheets the user can have loaded in NMS at any one time. If the user attempts to load more sheets than this, then they will be issued an error indicating the limit. |
OnlyIncludeMiscLogStepsForEventSteps | true/false | When adding steps to the Event Details Steps tab, only pull steps from the Misc Log. If the steps are recorded under another Event's Steps list or are part of another sheet, then leave those steps where they are. The Event Log for the event will still show the operational steps related to that event. When set to false, we'll gather steps from sheets and the Misc Log. We will take any step that has a JobStep relationship to the event in question. By default this option is set to true. |
RESET_SAFETY_STATE | Number Value | State key to reset safety documents to during a Training Scenario Reset Model operation. |
RESET_SHEET_STATE | Number Value | State key to reset switching sheets to during a Training Scenario Reset Model operation. |
SAFETY_ATTRIBUTE_UPDATE. number_of_rules | Number | The number of SAFETY_ATTRIBUTE_UPDATE rules defined. The SAFETY_ATTRIBUTE_UPDATE rules define when device attribute driven fields on a safety document should be updated. |
SAFETY_ATTRIBUTE_UPDATE.#.required_doc_states | Comma Delimited List of Safety Document State Keys | One of the states the safety document must be in for the rule to apply. If blank, then all states. |
SAFETY_ATTRIBUTE_UPDATE.#.required_doc_types | Comma Delimited List of Safety Document types | The type of safety document this rule should apply to. If blank, then all types. |
SAFETY_ATTRIBUTE_UPDATE.#.source_device_handles | Comma Delimited List of Field Names | The device class and index fields from the parent switching sheet. |
SAFETY_ATTRIBUTE_UPDATE.#.source_attribute_fields | Comma Delimited List of Field Names | The attribute fields from the database view ATT_SUPPLIMENTAL_ATTRIBUTES. To exclude attributes from the parent switching sheet and only include step (device) column values, then specify "IGNORE". The source_attribute_fields, source_step_fields and target_fields config parameters must have the same number of comma delimited values. All rule parameters must be specified even if you do not intend to assign it a value. |
SAFETY_ATTRIBUTE_UPDATE.#.source_step_fields | Comma Delimited List of Field Names | The step field names as defined for each column in the SafetyBody.xml file. To exclude step (device) values, indicate "IGNORE". |
SAFETY_ATTRIBUTE_UPDATE.#.target_fields | Comma Delimited List of Field Names | The target fields on the body of the safety document that should be populated with the accumulated data. |
SAFETY_ATTRIBUTE_UPDATE.#.only_populate_target_when_blank | true/false | Only populate the target_fields if they are blank. |
safety.copy.num_types | Number | The number of safety copy-clear field rules defined. The safety.copy rules define the fields that should be cleared in a safety document when it is copied. |
safety.copy.type#.clear_extns | Comma Delimited List | A comma delimited list of safety document extension fields that should be cleared when a safety document is copied. |
safety.copy.type#.name | String | The safety document type that has safety copy-clear field rules. |
safety.copy.type#.stand_alone_keep_actions | Comma Delimited List | The list of control actions that should be kept when a safety document is copied as a stand alone safety document. For instance, safety documents have Place condition, Remove condition and safety state transition actions, but when copied only the Place condition actions are needed in the new stand alone safety document. Device operation (Open/Close) actions are prohibited. The format of the values are <act_cls>:<act_idx>. act_cls and act_idx pairs are a subset of the actions configured in the swman_safety_type_actions table. Example for a Hold Document: CONDADD:hold, DDS:EARTH |
Safety.device.status_icon.<EDIT STATE> | String Value - Icon name | This parameter defines the icon name for each of the device list edit states. The device list edit states include: • ADD - The device has been added as part of a viewer device selection. • ADD_STEP - The device has been added as part of a switching sheet step association. • COND_APPLIED - The condition has been applied and updated to the device in the device list. • INCOMPLETE - The device is associated to a switching step where the condition has already been applied to the device. • REMOVE - The device has been marked for removal and will be removed the next time the document transitions from the Unissued to Issued state. • REMOVED - The device has been removed from the device list. These devices are filtered out of the device list. |
safety.extensionIgnoreList | Comma Delimited List | List of safety document extension values that may be used internally, but should not be saved to the database. As such, if an extension is in this list and not configured as an extension value in the eclipselink‑orm.xml file, then no error will be issued for a missing extension that does not have a matching SWMAN_SAFETY_DOCS database tab |
safety.num_types | Number Value | The number of safety document types as defined by the number of safety.type#.name parameters. |
safety.type#.link_allowed_states | Comma Delimited List | The comma delimited list of safety document states. If a switching sheet’s associated safety document is of the specified type (safety.type#.name) and it's in one of the configured states specified by this parameter, then that safety document will be included in a switching sheet step’s Link to Safety Document right click context menu option list. For more details, see description for the Link to Safety Document option described in the Oracle Utilities Network Management System User's Guide. |
safety.type#.name | String Value | The safety document type. The type# parameter will be "type1" to "typeN" where "N" is the number specified in parameter safety.num_types. Each numbered parameter value will be a single document type. For instance, values could be, but not limited to, HOLD, HOT, CLEAR, INFO. or WARN. |
safety.unlinkConditionsFromSheetSteps | true/false | This configuration option defines how a project utilizes conditions and how they relate to switching steps and safety documents. When this option is set to false, specific conditions are tracked in the safety documents and in the switching sheet steps. When the option is set to true, the only thing switching sheet steps and safety documents are looking for is a condition type and not a specific condition. For further details see the documentation for the JBot command StateTransitionCommand. In Product configuration, search for status flag UNLINK_CONDS_FROM_SHEET_STEPS and where it its true value is checked for an example on how to use the parameter. Product uses this JBot status flag to track the setting of this unlinkConditionsFromSheetSteps parameter and configure Product to work appropriately based on the parameter value. |
SaveSheetUserPrefs | true/false | Switching sheet preferences are stored for the one sheet that has focus when preferences are stored. Some projects may have significant configuration differences between their sheet types and this can cause issues if a user has a sheet up when their preferences are saved. For these projects, the only option is to not have a sheet up when preferences are saved or turn this option to false to keep your users from accidentally saving switching sheet related preferences that may not apply to all of the project's sheet types. By default, if this property is not set, it will be set to true. |
FlisrMiscStepsBlockHeaderDescription | String Value | This parameter defines the header description for the miscellaneous steps block in a FLISR switching sheet. All of the miscellaneous actions related to the FLISR event are displayed in this block of steps. Product configured description is "Miscellaneous Steps". |
SHEET_ATTRIBUTE_UPDATE.number_of_rules | Number | The number of SHEET_ATTRIBUTE_UPDATE rules defined. The SHEET_ATTRIBUTE_UPDATE rules define when device attribute driven fields on a switching sheet should be updated. |
SHEET_ATTRIBUTE_UPDATE.#.required_sheet_states | Comma Delimited List of Sheet State Keys | One of the states the switching sheet must be in for the rule to apply. If blank, then all states. |
SHEET_ATTRIBUTE_UPDATE.#.required_sheet_types | Comma Delimited List of Sheet types | The type of switching sheet this rule should apply to. If blank, then all types. |
SHEET_ATTRIBUTE_UPDATE.#.source_device_handles | Comma Delimited List of Field Names | The device class and index fields from the switching sheet. |
SHEET_ATTRIBUTE_UPDATE.#.source_attribute_fields | Comma Delimited List of Field Names | The attribute fields from the database view ATT_SUPPLIMENTAL_ATTRIBUTES. To exclude attributes from the switching sheet and only include step column values, then specify "IGNORE". The source_attribute_fields, source_step_fields and target_fields config parameters must have the same number of comma delimited values. All rule parameters must be specified even if you do not intend to assign it a value. |
SHEET_ATTRIBUTE_UPDATE.#.source_step_fields | Comma Delimited List of Field Names | The step field names as defined for each column in the SwmanSteps.xml file. To exclude step values, indicate "IGNORE". |
SHEET_ATTRIBUTE_UPDATE.#.target_fields | Comma Delimited List of Field Names | The target fields on the body of the switching sheet that should be populated with the accumulated data. |
SHEET_ATTRIBUTE_UPDATE.#.only_populate_target_when_blank | true/false | Only populate the target_fields if they are blank. |
SHEET_STATE_FROM_STEP.#.disallowed_step_states | Comma Delimited List of Step State Keys | This is the list of states that will keep this rule from being applied. If any step is found with any of these states, then the sheet state action will not be applied. |
SHEET_STATE_FROM_STEP.#.required_sheet_states | Comma Delimited List of Sheet State Keys | This is the list of sheet states that will allow this rule to be applied. This rule is normally used when there are no steps in the sheet and the state of the sheet has to be used instead. For instance, when removing steps from a sheet. |
SHEET_STATE_FROM_STEP.#.required_sheet_type | Comma Delimited List of Sheet types | This is the list of sheet types that will allow this rule to be applied. This is normally used to restrict rule to specific sheet types. |
SHEET_STATE_FROM_STEP.#.required_step_states | Comma Delimited List of Step State Keys | This is the list of states that will trigger this rule to be applied. If any step is found with any of these states, then the sheet state action indicated in this rule will be applied to the sheet. |
SHEET_STATE_FROM_STEP.#.sheet_state_action | Single Sheet State Action Name | This is the sheet state action name that should be applied to the sheet when the disallowed_step_states and required_step_states checks have passed. See database table TE_STATE_ACTIONS for a list of available actions configured where the APP field is equal to WSW. If needed, multiple sheet states to transition through can be provided by listing the sheet states in a comma delimited string. The sheet will be transitioned through the states, from left to right, as they are listed in the string. This may be needed for situations where the plan needs to transition first to an intermediate state before it can be transitioned to the desired final state. An example within product configuration would be to transition to "In‑Progress (Instructed)" to "In‑Progress(Completed)" to "Completed" after all steps in a plan have been completed successfully. |
SHEET_STATE_FROM_STEP.number_of_rules | Number Value | The number of sheet state from step rules configured from 1 to the value configured for this parameter. |
SHEET_STATE_TRANS.<Sheet Class #>.<Current Sheet State>.<New State Action Name>.AuditLogMsg = {SWMAN_AUDITLOG.STATE_CHANGE.text} | String Value | This is the audit log message to be populated into the SWMAN_AUDIT_LOG database table. This value will be populated into the LOG_COMMENT record field. This value can include a variable from the sheet tool's property file. In which case, the variable will be substituted for the value defined in the tool's property file. That same property value is normally used for state transition messages configured on the client side. |
SHEET_STATE_TRANS.<Sheet Class #>.AuditLogType | String Value | This is the audit log type to be populated into the SWMAN_AUDIT_LOG database table. This value would be populated into the AUDIT_LOG_ENTRY_TYPE record field. For state transitions, this would normally be set to STATE. |
SHEET_CURRENT_FEEDER_UPDATE.number_of_rules | Number Value | The number of sheet feeder update rules configured from 1 to the value configured for this parameter. The rules are used to populate a switching sheet's Current Feeder and Current Substation fields with values as determined from the sheet's master device and devices used to populate the Steps list. All rule parameters must be specified even if you do not intend to assign it a value. The first rule that matches a sheet's type and states will be used and no further rules will be applied for that sheet. |
SHEET_CURRENT_FEEDER_UPDATE.#.required_sheet_types | Comma Delimited List of Sheet Class Numbers | The types of sheets that this rule will apply to. If blank, then this check applies to all sheet types. |
SHEET_CURRENT_FEEDER_UPDATE.#.required_sheet_states | Comma Delimited List of Sheet State Keys | One of the listed states the sheet has to be in for the rule to apply. If blank, then this check applies to all sheet states. |
SHEET_CURRENT_FEEDER_UPDATE.#.target_feeder_field | String Value | The target field that should be populated with the list of current feeders. |
SHEET_CURRENT_FEEDER_UPDATE.#.target_substation_field | String Value | The target field that should be populated with the list of current substations. |
SAFETY_CURRENT_FEEDER_UPDATE.number_of_rules | Number Value | The number of safety document feeder update rules configured from 1 to the value configured for this parameter. The rules are used to populate a safety document's Current Feeder and Current Substation fields with values as determined from the document's master device and devices used to populate the Device lists. The document's master device is only used when dealing with stand-alone safety documents. These rules also do not apply if the parent sheet type does not have a rule that will update similar fields. In other words, the parent sheet has to be updated before the associated safety documents can be updated. All rule parameters must be specified even if you do not intend to assign it a value. The first rule that matches a document's type and states will be used and no further rules will be applied for that safety document. |
SAFETY_CURRENT_FEEDER_UPDATE.#.required_doc_types | Comma Delimited List of Safety Document Class Numbers | The types of safety documents that this rule will apply to. If blank, then this check applies to all safety document types. |
SAFETY_CURRENT_FEEDER_UPDATE.#.required_doc_states | Comma Delimited List of Safety Document State Keys | One of the listed states the safety document has to be in for the rule to apply. If blank, then this check applies to all safety document states. |
SAFETY_CURRENT_FEEDER_UPDATE.#.target_feeder_field | String Value | The target field that should be populated with the list of current feeders. |
SAFETY_CURRENT_FEEDER_UPDATE.#.target_substation_field | String Value | The target field that should be populated with the list of current substations. |
sheet.copy.num_types | Number | The number of sheet copy-clear field rules defined. The sheet.copy rules define the fields that should be cleared in a switching sheet when it is copied. |
sheet.copy.type#.class | Number | The class of switching sheet that has sheet copy-clear field rules. |
sheet.copy.type#.clear_extns | Comma Delimited List | A comma delimited list of switching sheet extension field names that should be cleared when a switching sheet is copied. |
sheet.copy.type#.clear_fields | Comma Delimited List | A comma delimited list of core switching sheet field names that should be cleared when a switching sheet is copied. For example: completedDate. |
sheet.copy.type#.clear_step_extns | Comma Delimited List | A comma delimited list of switching sheet step extension fields that should be cleared when a switching sheet is copied. |
sheet.copy.type#.copy_tables | Comma Delimited List | A comma delimited list of generic tables that should be copied when a switching sheet is copied. See “Generic Tables” for information. |
sheet.extensionIgnoreList | Comma Delimited List | List of sheet extension values that may be used internally, but should not be saved to the database. As such, if an extension is in this list and not configured as an extension value in the eclipselink‑orm.xml file, then no error will be issued for a missing extension that does not have a matching SWMAN_SHEET database table column. |
sheet.replication.limit | Number | Replication Switching Sheet Rule. A hard limit on how many switching sheets are allowed to be created based on a replication pattern and date period specified on the Request tab. This is only valid for Planned sheets. |
sheet.requireFuzzyAuthority | true/false | If this parameter is set to true, then the user is required to take authority of the FUZZY zone to see switching sheets that are not associated to a modeled device. This parameter only comes into play when the environment is setup to filter switching sheets within the Open Switching Sheet list based on zones of authority. |
STAND_ALONE_SAFETY_EDIT_FLAG | JBot Flag Name | This is the flag used to determine if the stand alone safety document has been edited or not. If it has been edited, then change the safety document tab label to an italicized text. |
STEP_STATE_COMPLETED | Control Tool Act Key | This act key is used by internal processing to determine if a step has been completed. |
STEP_STATE_INSTRUCTED | Control Tool Act Key | This act key is used by internal processing to determine if a step has been instructed. |
STEP_STATE_SCADA_INSTRUCTED | Control Tool Act Key | This act key is used by internal processing to determine when a step has been SCADA Instructed. |
step.closeActKey | Control Tool Act Key | This act key is assigned to a step when an CLOSE device operation message is processed by the Web Switching service. This can happen when a device is closed by a SCADA system. |
step.crew.backToMasterDev | true/false | This option defines whether the crew should migrate back to the switching sheet's master device within the viewer when a step has been instructed and completed. If set to false, the crew will remain on the last instructed device after it has been completed. |
step.extensionIgnoreList | Comma Delimited List | List of step extension values that may be used internally, but should not be saved to the database. As such, if an extension is in this list and not configured as an extension value in the eclipselink‑orm.xml file, then no error will be issued for a missing extension that does not have a matching SWMAN_STEP database table column. |
step.openActKey | Control Tool Act Key | This act key is assigned to a step when an OPEN device operation message is processed by the Web Switching service. This can happen when a device is opened by a SCADA system. |
SuppressMovingMiscLogSteps | String Value | When creating a switching sheet for an event, suppress the logic that moves the event's associated steps from the Misc Log to the newly created switching sheet. This parameter takes a comma delimited list of sheet types. For example: FLISR, Emergency |
SWMAN_STATES_TO_EXCLUDE_QUERY | String Value | This is the database SQL query to get terminal or final states for sheets which would be excluded while processing model changes. |
SWMAN_STEPS_QUERY | String Value | This is the database SQL query to get steps with excluded states and types of sheets. To disable this query, set it to an empty string. If this query is enabled again, you should run the following database update: UPDATE swman_patches SET patch_time = SYSDATE; If you do not, you risk having the system process a lot of unnecessary model changes that have occurred since the last time the logic was enabled. • Replace the alias $SWMAN_STATES_TO_EXCLUDE_QUERY$ with a literal list of values for the states to exclude, otherwise the result of SWMAN_STATES_TO_EXCLUDE_QUERY will be used. • Replace the alias $SWMAN_TYPES_TO_EXCLUDE_QUERY$ with a literal list of values for the sheet types to exclude, otherwise the result of SWMAN_TYPES_TO_EXCLUDE_QUERY will be used. |
SWMAN_TYPES_TO_EXCLUDE_QUERY | String Value | This is the database SQL query to get terminal or final sheet types which would be excluded while processing model changes. |
SWMANSHEET_TITLE_JBOT_CONFIG_PARAM | JBot Flag Name | This is the flag to check to determine if the sheet has been edited or not. If it has been edited, then change the sheet tab to an italicized text. |
WAIT_TIME_FOR_EVENT_UPDATES | Number Value | The number of milliseconds to wait before submitting a request to gather event and crew information for a switching sheet. During this wait, if another update request comes in then the timer is reset. This feature is in place to eliminate multiple unnecessary requests back to the server for event and crew related updates when the client is receiving a ton of requests. This can happen in a storm or when an event suddenly generates a lot of SRSOutput messages. This timer is not used when first loading a switching sheet. This timer based delay is only used when getting updates dynamically as part of an outside update request. Default value is 1000. A setting of 0 will disable the feature, but will also impact performance of the environment. |