Use the SugarCRM REST API Get Reports activity to retrieve
specific reports from the SugarCRM server.
About this task
Use this task to retrieve specific reports from the SugarCRM
server. The call to this activity is a synchronous call where the
input data is sent to the activity for processing and the response
is sent back to the orchestration.
Procedure
- In an active orchestration, open the Activities tab and expand the SugarCRM REST API folder
contents.
- Drag the Get Reports activity icon
onto the orchestration. The SugarCRM REST API Get
Reports Checklist is displayed.
- In the Checklist, click Summary.
- Review the contents of the Activity Name field, and make the required changes.
- In the Checklist, click Pick Endpoint.
- Click Browse and use the Project Explorer dialog box to select the relevant SugarCRM
REST API endpoint.
- Optional: You can create the endpoint by clicking New and specifying the required connection details. Click OK to save and use the endpoint for this configuration.
- To make required changes to the selected endpoint configuration,
click Edit to access the options in a separate
window. Any changes you make globally affects all uses of the endpoint
in active orchestrations.
- Select the Map Inputs in the Checklist. The XML Schemas generated from the selected
object of the Get Reports activity are displayed
as nodes under the request input parameter in the To Activity panel.
- Create a map between the orchestration variables and the
input parameter of the activity.
Note: Values must be
provided at run time for any mandatory elements of the input structure.
A value can be provided by specifying a default value for element
or by linking the element with an input node. During run time if no
value is provided for a mandatory element, the activity throws an
exception, which is reported by the Web Management Console. If a value
is not provided at run time for an optional input parameter, no exception
is thrown during run time.
- Select the Map Outputs in the Checklist. The XML Schema generated to hold the response
of the activity is displayed as nodes under the response output parameter
in the From Activity panel.
- Create a map between the output parameters and orchestration
variables.
Results
You have configured the SugarCRM REST API Get Reports activity.
Note: You can add more than one object as input to this activity.
To add more than one object as input, right click the object in the To Activity pane of Map Inputs, and select Expand Occurrences. Only multiple
objects of the same type is supported.