Configuring the In-Context Information widget
This widget supports user-based
configuration only.
-
Click the menu icon (...) on the widget title bar and select any
of these options:
- Configure > Create Static Chart: Select to show a chart which does not depend on context value.
- Configure: Select to show a new chart which depends on context value.
- Edit Chart: Select to edit the configuration of existing charts in the widget.
-
On the General tab,
specify this information:
- Name
- Specify the name of the chart.
- Type
- Select the chart type from the options.
- Screen association
- To show the widget on a specific M3 program, specify the M3 program, for example, CRS610. This field is not available for static charts.
- Color picker
- Select the chart color.
-
On the Data Retrieval
tab, specify this information:
Note: To display the charts, the selected API program, transaction, and query must be valid.
- API program
- Select the M3 program, for example OIS100MI.
- API transaction
- Select a transaction, for example Search.Head.
- Query, Arguments
- Specify the query or the argument to use to retrieve data. If
functional search macros are supported, the values must be enclosed
in {}. For example, ITNO:{ITNO}
WHLO:{WHLO}.
For non-functional search, insert comma between the list of fields and values. For example, ITNO,{ITNO},WHLO,{WHLO}. See Supported macros for the input field.
To help in building the correct query or arguments, you can click these icons:- Field Help: Shows the available transaction fields that you can select to include in your query or arguments. The options in bold text are required. For functional search transactions, only the SQRY - Search Query option is available so this tool is more useful for non-functional search transactions.
- Show received context keys and values: Shows the list of keys and values that are last received by the widget. Use the list as a reference.
- Test API:
Opens a dialog box where you can test your query or
argument. These options are available:
- Query or Arguments: This field shows a copy of your query or arguments. If blank, specify the query or the argument to use to retrieve data.
- Test API: Click this button to validate your specified query or arguments. A message is displayed to indicate whether the transaction is valid along with the number of records that are returned by the valid transaction.
- Save query upon close: Select this check box to copy your query or arguments to the Query or Arguments field on the Data Retrieval tab.
- Search
- Select this check box to indicate that the API transaction is a functional search. If this check box is clear, the Query field becomes Arguments field.
-
On the Data Value tab,
specify this information:
- Value type
- Select the method of how the data is processed from these
options:
- Count: Count the number of returned records.
- Sum: Summarize the value of a numeric field in the returned records.
- Value field
- If you are configuring a List chart, select the fields to display on the list. If you selected Sum in the Value type field, select the fields to summarize and display on the chart.
- Group by field
- Specify the field by which the data is grouped. For example, to create a chart with stopped orders per customer, select CUNO.
- Formatter - Group by field
- If applicable to your chart type, select the format of the value in the Group by field field. For example, if you select Year and month, 20230330 becomes March-2023.
-
On the Drillback tab,
specify this information:
- Program
- Specify the program in M3 from where the data is based. For functional search transactions, a drillback opens the program and performs a functional search. For non-functional search transactions, a drillback only opens the program and the data must be manually searched.
- Sorting order
- If applicable to your program, select the field by which the data is sorted.
- View
- Select which type of view the chart is displayed.
-
On the Settings tab,
specify this information:
- Max records
- Specify the number of maximum records to display in the chart.
- Sort by
- Select a method for sorting the data. If you are using formatters, it is recommended to leave this field blank.
- Priority
- Specify a number from 1 to 99, where 1 is the highest priority and 99 is the lowest. In case multiple charts are valid, the chart with the highest priority is displayed first. When configuring a new chart, the priority is set to 50 by default.
- Rotate labels
- Select this check box to show the long labels diagonally to prevent overlap.
- Use short names when available
- Select this check box to show a shorter version of the label. For example, January-2023 becomes Jan-2023.
- Click Save.