Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
en:extensions:workflowdesigner:soap-extension [2016/05/08 17:51] swarnat created |
en:extensions:workflowdesigner:soap-extension [2016/05/08 19:34] (current) swarnat [Documentation] |
||
|---|---|---|---|
| Line 5: | Line 5: | ||
| You are also able to transfer parameters and use them in your Workflow. | You are also able to transfer parameters and use them in your Workflow. | ||
| - | In the first version there is no option to response some information from Vtiger to your Application. This will implemented within the next update. | + | In the first version there is no option to get a response with information from Vtiger for your Application. |
| + | This will implemented within the next update, together with the option to send files. | ||
| - | Download here: TBD | + | Download here: [[https://shop.stefanwarnat.de/wp-content/plugins/download-monitor/download.php?id=14|Download Module file]] |
| ==== Documentation ==== | ==== Documentation ==== | ||
| + | |||
| + | === Setup === | ||
| + | |||
| + | Install the extension in the Module Manager of VtigerCRM. | ||
| + | |||
| + | === Usage === | ||
| This module integrate itself into the Vtiger own SOAP Webservice. You need to have a valid login, which should be done before you send the operation. | This module integrate itself into the Vtiger own SOAP Webservice. You need to have a valid login, which should be done before you send the operation. | ||
| Line 15: | Line 22: | ||
| The operation will always be from request type POST. | The operation will always be from request type POST. | ||
| All parameter you send to the operation by POST will be available in the Environment variable **$env["parameter"]**. | All parameter you send to the operation by POST will be available in the Environment variable **$env["parameter"]**. | ||
| + | |||
| + | The Workflow will be executed without a record by default. So you cannot use any default field variable. | ||
| + | If you submit a parameter **crmid**, you specify the record, which the Workflow Designer should use for this. | ||
| === Example === | === Example === | ||
| + | |||
| + | <code php> | ||
| + | // The SOAP Operation must have this name. You must specify your operation name | ||
| + | $operationName = "81e4a_leadrequest" | ||
| + | // This example will transfer 3 parameter to the workflow | ||
| + | // Login before and store the Session ID in the variable $sessionId | ||
| + | $response = post($endpointUrl."?operation=".$operationName."&sessionName=".$sessionId, | ||
| + | array( | ||
| + | 'firstname' => 'Stefan', | ||
| + | 'lastname' => 'Warnat', | ||
| + | 'email' => 'email@stefanwarnat.de' | ||
| + | ) | ||
| + | ); | ||
| + | |||
| + | </code> | ||
| + | |||
| + | Now you could create a workflow which access the variable **$env["parameter"]["firstname"]** to get the firstname and similar to access lastname and email. The maximum transportable content depend on your vtiger webserver config. Per default it is set to 2048 KB (2 MB). | ||