Enable Paging within your Connector
Before paging will work in Cyclr, you need to enable Inbound Paging.
At Connector-level, settings tab:
- Check the ‘Inbound Paging?’ checkbox.
- Set Inbound Page Size according to the number of objects you want returned on one page.
Congratulations, you have just enabled paging on your Connector. However, paging will not work yet until you have configured your variables. So the next thing you need to do is set up your paging parameters in Cyclr.
Setting Connector Level Paging Parameters
Paging parameters are generally set at Connector level so that they can be easily applied to all methods which use paging. Typically, APIs will use the same type of paging across all their paging-methods for consistency. However, you can set paging up in Method level as well if needed.
One way you can add paging parameters is by using Query-type parameters at the Connector-level. You will usually need two Query parameters for paging, one for paging limits and the other for page numbers.
To begin, create two QueryString Parameters, and name them after the paging parameters of the method, limit and page. Make sure they are set as hidden and optional.
Luckily, you can integrate the limit and page numbers so that Cyclr can handle them without our input. You can do this by assigning them specific Cyclr values.
To make Cyclr automatically set the page size, add a Parameter Value for the limit variable called ‘CYCLR_PAGE_SIZE’.
To make Cyclr automatically increase the page number with each request, we create a value for the ‘page’ parameter called ‘CYCLR_PAGE_NUMBER’.
To create a parameter value, navigate to the Parameters tab of your Connector and select the Parameter Values option, this is represented by a menu button.
This opens up the Edit Parameter page, from here select the Add a Value button to add your Cyclr paging parameter values for page and limit. Remember to click on Save to save your changes.
Using Paging Parameters with Methods
After you have added the Paging parameter settings on the Connector level, you can apply them to your Methods that require Paging. This would be usually any “List” type methods.
To do this, access the Method-level Settings tab on the methods that require paging, and make sure Inbound Paging is set to ‘true’.
In the method level settings tab you can set inbound paging to ‘true’ or ‘false’. Make sure all paging methods have Inbound Paging set to ‘true’ and all non-paging methods have Inbound Paging set to ‘false’.
Remember to test the methods to ensure that paging is working as intended.
Visit our Documentation for examples on Connector-level properties that you can use when setting Paging for your Connector!