This field is used to display data in a customizable card layout. Data for the cards is returned from a target. Cards can be laid out horizontally or vertically and have two layouts, basic and advanced. Basic is a predefined generic layout that allows you to easily slot in data that’s automatically formatted on the card for you. The advanced layout gives you full control of the cards appearance, allowing you to specify raw HTML with your own CSS styles to tailor the cards look to suit your business requirements and populate them with the returned target data.
The card field also supports search components. Refer to the Search Components article for more information.
Example of the Basic card layout:
Example of the Advanced card layout:
Here is an example of the field definition when the Type is Basic:
Here is an example of the field definition when the Type is Advanced:
Below are the fields and their purpose:
- Search Component – The Compound to be used as a Search Component. This field is optional.
- Target – The target that will be called to get the card data.
- Orientation – Determines the orientation of the cards.
- Type – Determines if the Basic or Advanced layout will be used for the cards.
- Enable Body Divider – Determines if there will be a divider between the body and body titles on the card. Only available when using the Basic layout.
- Page Size – Determines how many cards will be displayed per page.
- Width (px) – Determines the width in pixels of the cards. Set this to 0 for cards to automatically size to the content to its smallest form.
- Display Action Buttons – Determines if the available commands/events/wizards for that instance will be displayed on the card. Selecting one of the buttons will execute the command/event/wizard.
- If this is set to Yes it’s highly recommended to return the InstanceStatus of the instance in the target so the component correctly refreshes.
- Load Card actions manually – If Yes will display a Load Actions button on each card instead of loading all the actions automatically if Display Action Buttons is set to Yes. This significantly improves performance of cards.
- Options button icon – Only displayed if Load Card actions manually is set to Yes. Allows you to customize the icon on the options button to a different font icon (e.g., Font Awesome).
- Options button text – Only displayed if Load Card actions manually is set to Yes. Allows you to customize the text on the options button.
- Add Open Button – Determines if the button to open the instance will be displayed.
- Add Open In Window Button – Determines if the button to open the instance in a popup window will be displayed.
- Add Delete Button – Determines if the delete button will be displayed.
- Suppress Commands/Events/Wizards – Contains the actions that will be suppressed and will not be displayed on the card if Actions Buttons are enabled.
- Card HTML – Only available when Type is Advanced. Contains the custom HTML for the cards.
- Card Keys – Only available when Type is Advanced. Allows you to specify the names of the columns in the target that contains the value that will be inserted into the HTML.
- Custom Instance Window Title – Determines if a custom title will be applied to the instance window if the card is opened in a popup window.
- Instance Window Title – Contains the title that will be displayed when the card is opened in a popup window.
- Enable Data Auto Refreshing
- Determines if the data will refresh automatically after a specified period of time.
- How often should the data auto refresh
- Determines how often the data will be automatically refreshed.
