Adding a data refresh button to lists that implement columnar tables
To make it easier for a list that uses a columnar table to have up-to-date data, you can add a Data Refresh button to the list. You can click this button to run the replication set that refreshes the columnar table for the list.
To use this procedure, you must have knowledge of the Configuration Console.
See the Configuration Console Web UI User Guide and the Configuration Console Reference Guide: Landmark Pattern Language (LPL).
- Complete these prerequisites:
- Ensure that the list that are adding a button to can use columnar data. The LPL for the list must include this line:
implements ColumnarView - Ensure that a search form exists for the business class that the list uses and that the lists references this search form. For example, the list LPL would include a line similar to this:
search form is GLTransactionDetailPrimaryList_SearchForm - A replication set exists for the business class that the list uses and that replication set is defined to create a columnar table.
- Ensure that the list that are adding a button to can use columnar data. The LPL for the list must include this line:
- Create a user action.
- Access the Configuration Console.
- Select Utilities > Business Logic Basic Access > Actions.
- Click Create and select Create New Action.
- In the right pane, specify this information:
- Business Class
- Select the business class the action belongs to.
- Action
- Specify a name for the action. Do not use spaces and ensure to follow your configurations naming conventions and prefix the name with a code such as ZZZ, Usr, or characters that represent your company name. For example, ACM for Acme Co.
- Override Default Action Label
- Select this check box in order to specify a label that is different than the default. The default label is based on the name of the action.
- Action Type
- Select Import.
- Click Submit.
- Select and open the user action that you created, then add this code to the LPL, replacing <ReplicationSetName> with the actual name of the replication set that populates the columnar table. Click Save.
Local Fields RepSet is a ReplicationSet Action Rules RepSet = "<ReplicationSetName>" invoke Replicate RepSet - Select Utilities > Business Logic Basic Access > Actions.
- Select the action you just created, click the Ellipsis button and select Assign Role.
This creates a security class for the user action. To view the security class, select Security Administration > Configurations > Master. Select and open the user action configuration you created, click Manage Security Class then the Roles tab.
- Select a role to which you want to assign the security class and click Submit.
- Create an action form for the user action you created.
- In the Configuration Console, select Utilities > User Interface Basic Access > Forms.
- Click Add New Form.
- Specify the business view, specify a name in the Form Name field and click Submit.
- Select and open the form that you created, then modify the LPL using this code. Replace <actionname> with the name of the user action you created earlier, and update the paragraph text to display the message shown in the dialog box when a user clicks the button to refresh data.
RefreshDataActionForm is an ActionForm action is <actionname> Layout paragraph text of "PressOKToRefreshColumnarData."
- Modify the list associated with the button you are creating.
- In the Configuration Console, select Create > Configuration tab > Tailor User Interface > Add a New Component > List.
- If the list is already present in the list configurations, open it. If it is not present, select Configuration Console > Create > Add a New Component > List.
- Select the business class, specify a name for the list and optionally select a list to base the new list on. Click Submit.
- Add this code to the LPL for the list, where <UserActionName> is the name of the user action you created earlier:
Actions action is <UserActionName> - Click Save.
- Test if the button on the list performs a data refresh.
Note: There are some lag time before the refreshed data is available. The lag time depends on the amount of data to refresh, whether many replication set operations are ahead in the queue or how many business classes are in the replication set.