Introduction
This page is used to maintain Question values. For several examples of its use see Inspection Question Examples
Important Information
- User profiles control which classification characteristic values get transferred to BlueWorx. The exception is those characteristics that are associated with Inspection Questions or used in the Inspection Template Assignment. These characteristics are maintained by the system in a hidden 'Inspection' user profile which gets updated periodically by scheduling the program: /SOTIUS/PM_PROCESS_RF_MD
- Aspects of this page, primarily the rich text editors, are dependent on SAPUI5 releases. The releases are maintained in a Neptune Software SAP table and must correspond to a SAP published release which SAP periodically change. If you have issues with the rich text editor then please see the following article for remediation steps: https://blueworx.freshdesk.com/support/discussions/topics/19000032632
Contents
Questions Tab
On this tab the main values for a Question are maintained. Here's a screen sample:
The screen is split into four columns and in some cases a bottom section. The fields displayed can change according to the values selected. The following defines each of the columns/ section on the Questions Tab:
ID and Control Column
The following screen fields and controls are defined, where not documented they are considered self explanatory or are explained elsewhere:
Field/ Function | Explanation |
---|---|
ID | A visible identifier for the question, remembering that a single question can be used in multiple Question Groups, which can be used in multiple Inspections. Note that in versions pre SP11 this field was the records Unique ID. |
Active | Indicates that the Question is active and ready for use or inactive. |
Authorization Group | This value is required where Authorization Groups have been activated for BlueWorx Administration. New from SP11 |
Control Reference | Optionally enter a reference to a control authority related to this question. i.e. Safety Control; Industry Control; Engineering Control (or any other reference where this functionality suits. Whatever values are entered into this field, and at the Inspection Header, are copied into the BlueWorx Inspection Viewers Question response results. New from SP11 |
Last Update | The User, Date and Time of the last time this question was updated. |
Change Docs button | Review change documents. For additional details see Change Documents This functionality was introduced in SP13. |
Question Instructions Column
The following screen fields and controls are defined, where not documented they are considered self explanatory or are explained elsewhere:
Field/ Function | Explanation |
---|---|
Description | This is the value visible description used in lists and question detail screens. |
Launches the HTML Editor, the content of which is displayed below the button. For more on the use of html content and images see Inspection html Content and Images | |
Reference URL | Maintain a URL for additional information. This will appear as a link in the question and, conditional on the operator having access rights and connectivity, for them to open in their browser. As of SP12, Placeholders are now supported in the Reference URL. Placeholders look like the following: %IE:EQUIPMENT%. This example could be included in an Inspection Question Reference URL, and when the link is navigated to in an Inspection Question, it will use the Equipment Number, retrieved from the associated Equipment Record, instead of the Placeholder. When creating a placeholder, the following format should be observed: %__:_______% -> Always surround with percent signs to identify it as a placeholder. %IE:_______% OR %IF:_______% OR %WO:_______% -> This prefix denotes which record you should retrieve the value from. This was added to ensure there isn't conflict in fields that are common between Work Orders/ Equipment / Functional Locations by allowing you to specify exactly where you want to get the data from. %CL:ATNAM% -> For classification placeholders, you can specify the Characteristic Name and it will retrieve the Characteristic Value. This should only be used for char like values. %__:FIELDNAME% -> The name of the field you want to retrieve the data from. Here are some examples of Reference URL's with placeholders: www.BlueWorx.com/EquipmentNumber=%IE:EQUIPMENT% www.BlueWorx.com/FunctionalLocation=%IF:TPLNR% www.BlueWorx.com/OrderNumber=%WO:AUFNR% www.BlueWorx.com/Classification=%CL:PUMP_TYPE% The list of fields you can retrieve from in Reference URL's can be found: SAP TCode -> SE11 Data Type: WO -> /SOLTIUS/PM_S_ORDER IE-> /SOLTIUS/PM_S_EQUIPMENT IF -> /SOLTIUS/PM_S_FUNC_LOC Any of the fields in their corresponding data types above can be used in Placeholders. |
Reference URL Description | The text that is shown for the Reference URL described above |
SAP Processing of Response Column
The following screen fields and controls are defined, where not documented they are considered self explanatory or are explained elsewhere:
Field/ Function | Explanation |
---|---|
Processing Type | The setting dictates what actions will occur in SAP as a result of responding to an inspection question. It also controls what configuration fields are visible in conjunction with the Response Type configuration value:
|
Update Technical Object Field | Select the Equipment or FL Field to update. Displayed only when the Processing type is Equipment of FL Update Allowed values are: Were E= Equipment; F = Functional Location and EF = both |
Characteristic 1 | Select the SAP Classification Characteristic. Displayed only when the Processing type is Characteristic Update |
Measurement Characteristic | Select the SAP Classification Characteristic for a Measurement Point. Displayed only when the Processing type is Create Measurement Document Note that if multiple Points are found for an Asset from the combination of Characteristic and Positions (through poor SAP master data maintenance) then processing in SAP will report an error in the Inspection Log. |
Latitude | The Characteristic to update a point assets Latitude Displayed only when the Processing type is Create Measurement Documentand the Response Type is Latitude/ Longitude |
Longitude | The Characteristic to update a point assets Longitude Displayed only when the Processing type is Create Measurement Documentand the Response Type is Latitude/ Longitude |
Accuracy | The Characteristic to update a point assets Latitude and Longitude Accuracy Displayed only when the Processing type is Create Measurement Documentand the Response Type is Latitude/ Longitude |
Altitude | The Characteristic to update a point assets Altitude Displayed only when the Processing type is Create Measurement Documentand the Response Type is Latitude/ Longitude |
Altitude Accuracy | The Characteristic to update a point assets Altitude Accuracy Displayed only when the Processing type is Create Measurement Documentand the Response Type is Latitude/ Longitude |
Start Latitude | The Characteristic to update a linear assets Latitude start position Displayed only when the Processing type is Create Measurement Documentand the Response Type is Latitude/ Longitude Pair or Distance and Lat/ Long Path |
Start Longitude | The Characteristic to update a linear assets Longitude start position Displayed only when the Processing type is Create Measurement Documentand the Response Type is Latitude/ Longitude Pair or Distance and Lat/ Long Path |
End Latitude | The Characteristic to update a linear assets Latitude end position Displayed only when the Processing type is Create Measurement Documentand the Response Type is Latitude/ Longitude Pair or Distance and Lat/ Long Path |
End Longitude | The Characteristic to update a linear assets Longitude end position Displayed only when the Processing type is Create Measurement Documentand the Response Type is Latitude/ Longitude Pair or Distance and Lat/ Long Path |
Distance | The Characteristic to update a linear assets distance (length) generally acquired by a distance wheel if on foot or an odometer if in a vehicle Displayed only when the Processing type is Create Measurement Documentand the Response Type is Lat/ Long Path |
Measurement Position | Optionally used in conjunction with Processing Type 'Create Measurement Document' to associate the correct Measurement Point for the Asset in conjunction with the Measurement Characteristic. Displayed only when the Processing type is Create Measurement Document |
Measurement Point Category | Optionally used to control the Code Group Category for Measurement Documents that expect Code Group responses. Displayed only when the Processing type is Create Measurement Document |
Create Notification (Question Based) | Used for optional questions to create a Notification. Values are:
Depending on the selection the following fields are exposed:
|
Notification Template | If you have selected Create Notification value 2. then this is the Notification Template that will be used |
Notification Type | If you have selected Create Notification value 3. then this is the Notification Template that will be used |
Approve Before Processing in SAP | If switched on then responses to this Question must be reviewed and approved from the Administration Application prior to being processed in SAP. For example, you might allow a user to propose changing the Description for an Equipment but want someone from your Master Data Management team to review before SAP update |
Review SAP Authorization Object | Shown only where Approve Before Processing in SAP in ON. This is the SAP Authorization object that approvers must have assigned to their SAP User Record before they can approve an Inspection result. The following is an example of this object: |
SAP Update Function | You can optionally maintain a custom Function Module to process the results for this Question. The function module must have the following parameters:
|
Response Control Column
The following screen fields and controls are defined, where not documented they are considered self explanatory or are explained elsewhere:
Field/ Function | Explanation |
---|---|
Response Mandatory | If On then this question must be answered to complete the overall Inspection |
Response Type | This dictates the value type responses expected to the question and controls some of the screen fields along with the Processing Type
|
Custom Response Key | Used to identify Custom Response Types. See Inspections - Custom Inspection Questions |
Maximum Response Length | Used in conjunction with Response Type Single Value Numeric to control the length of the numeric value entered as a response. When the processing type is characteristic update or measurement document creation this value will be populated from the characteristic configuration settings on save. Note:
|
Number of decimals allowed | Used in conjunction with Response Type Single Value Numeric to control the number of decimals allowed in the numeric value entered as a response. When the processing type is characteristic update or measurement document creation this value will be populated from the characteristic configuration settings on save. Note: When max response length is zero and the Number of decimals allowed is zero then there will be no restriction on the number of decimals (apart from the overall field length as discussed above) |
Negatives allowed | Used in conjunction with Response Type Single Value Numeric to control whether negative numeric value can be entered as a response |
Manage Allowed Values | Select what values will be displayed for entry. Can be:
Options 2 and 3 also allow the triggering of Notification creation based on selected value; for example, for a low asset condition grading. This can either be by directing users into the Notification process in the BlueWorx application or more simply requiring them to enter text in the Question screen and then creating the Notification on processing in SAP using a configured template. Note: When using an Answer Group in a Question which updates a Characteristic value, the Answer Group answers are limited to those which are valid for the Characteristic. |
Display Alternative Characteristic | Switch on to display, in addition to other values, an alternative SAP classification value. This can help in a user's assessment or their responses - for example, you may show the build date so an assessment of the condition against appropriate standards for a period can be made. Where this switch is ON two other fields are displayed:
|
Default to today | Used in conjunction with Response Type Single Date Value to auto propose the value of the response to 'today' based on device date |
Prohibit future date | Used in conjunction with Response Type Single Date Value to stop the entry of values beyond today |
Alt Display Characteristic | See Display Alternative Characteristic above for an explanation |
Alt Display Label | See Display Alternative Characteristic above for an explanation |
Hide Current Value | Optionally elect to hide the existing value - for example, the classification value. This forces the user to make a genuine assessment and not just copy the existing value. Only questions which store the results in a SAP field can have an existing value. The current value is not the last answer to question for the inspected object. |
Sum All Sections | Used in conjunction with Multiple Answers response type to Sum all Responses (and potentially update a Characteristic value) |
Notification per Answer | Used in conjunction with Multiple Answers response type to create an SAP Notification per response |
Allow GPS to be Edited | Used where a GPS value is used, this optionally allows the user to correct the measurements from the device. For example, use a more accurate reading from a dedicated and more accurate GPS unit. |
Comment Entry Mandatory | Forces the entry of comment text. This is generally used in conjunction with the 'Create Notification' option where a 'Notification Template' is used - i.e. to capture some relevant text information for use in Notification Creation. |
Attachments Allowed | This option allows users to upload documents (photos and files) against the question for storage in SAP GOS against the inspection object. As of SP13 this option has been extended to allow the settings:
|
Complete and Move Next on Change | This option is available for answers based on Characteristic Values or Answer Groups. It means that on selection from the list of values navigation will move to the next question or return to the list based on the Navigation Type value (see below) |
Allow Question to be Answered in List | If set ON this setting allows the user to answer the Question in the Question List without requiring them to navigate to the Question Detail dialog. This option is available for these response types:
New from SP12 |
Navigation Type | This setting is used in conjunction with a similar setting at the Inspection level to either move to the next question on completion or return to the Inspection Question list. Allowed values are:
|
Characteristic Allowed Values
When you are using Classification Characteristic values (i.e. Processing Type Characteristic Update) and have selected the Manage Allowed Values option of Classification Values the following screen section is shown. You can use this to control what of the maintained SAP classifications values can be selected, which is defaulted, and where their selection drives the background creation of a SAP Notification or forces the creation of a Notification on the device:
The following screen fields and controls are defined, where not documented they are considered self explanatory or are explained elsewhere:
Field/ Function | Explanation |
---|---|
Answer Value | Derived from SAP allowed values for Characteristic |
Answer Description | Derived from SAP allowed values for Characteristic |
Hide | Hides this value from user selection |
Sort | Sort Order of values |
Notification | Option to:
|
Type | Notification Type - used in conjunction with Notification option 3 above |
Comments Mandatory | Force the entry of comments. Often used in conjunction with Notification option 2 above |
Default | The default option |
HTML Editor
The Instructions can include basic HTML content including tables, images, etc:
Note that the inclusion of table or images in the Instructions text will prohibit it being answered in the Question List (functionality introduced in SP12).
Footer Functions
The following screen fields and controls are defined, where not documented they are considered self explanatory or are explained elsewhere:
Field/ Function | Explanation |
---|---|
Change Docs button | Review change documents. For additional details see Change Documents This functionality was introduced in SP13. |
Inspection Viewer button | This button launches the Inspection Viewer application and passes the Inspection Question value. The allows the administrator to see all Completed uses of this Inspection Question. This functionality was introduced in SP11. |
Delete button | Use this button to Delete the Inspection Question. |
Copy button | Use this button to Copy the Question as a new Question. |
Save button | Use this button to Save changes to the Question |
Documents Tab
This functionality was introduced in SP13 and allows Inspection Administrators to add one or more pre-configured documents to a Question. More details on Inspection Document Templates is available here.
Field/ Function | Explanation |
---|---|
Add Document Template button | Add one or more Document Templates to be available by users responding to this Question at the Question Detail level |
Remove | Remove association the the document Template with this Question |
Question Groups Tab
This tab displayed the Question Groups against which this Question is assigned. You can't edit the assignments here, they must be done from the Group:
Rules Tab
The Rules table shows those Rules that either reference this Question for Conditional evaluation or take Action against this Question:
For more on Inspection rules see Inspection Rule.
Translations Tab
You can maintain translation values for the Inspection Description and Instruction.