Working with Incoming Web Service Connections

if you are creating an incoming web service connection to use with dsm, do not use this workspace! instead, configure the dsm integration from the dsm workspace see configuring the new dsm integration docid\ x0r5tiz6qouj7r9ii2xys for complete information about configuring an incoming web service for dsm viewing, editing, cloning, and deleting incoming web service connections docid\ j7tnsjafp3ohqrnokepmvadding an incoming service docid\ j7tnsjafp3ohqrnokepmvadding an incoming service reference docid\ j7tnsjafp3ohqrnokepmvtesting the incoming web service connection docid\ j7tnsjafp3ohqrnokepmv viewing, editing, cloning, and deleting incoming web service connections strongly recommends using the secure protocol https instead of http within the platform to ensure data security and integrity from the configuration console, click extend > integration tools > web service connections (beta) to open the web service connection manager (beta) workspace web service connections (beta) workspace the web service connection manager (beta) workspace has two sections outgoing (see working with outgoing web service connections docid\ j7tnsjafp3ohqrnokepmv ) and incoming the incoming web services section contains the following fields field description calls from external web services to ivanti (incoming) service the name of the external service that calls , such as salesforce service reference the name of the service action that the external service performs on an example is update employee service address (url) the service address url the url must be in the following format https // heat sm server port /inboundwebservice/ tenant url / web service page asmx an example is https //heatdev solys local/inboundwebservice/heatdev/servicetest asmx last transfer the date and time of the last request received by from the external service to edit an existing service or service reference, click the edit icon next to its name to clone a service, including all of its service references, do the following a click the clone icon next to its name b in the confirmation message, click ok the application displays the new service in the list to activate or deactivate a service or service reference, click the activate toggle icon next to its name this makes the web service connection active or inactive when it is inactive, the application cannot process the web service to delete a service or service reference, do the following a click the delete icon next to its name b in the confirmation message, click yes if there are any mappings associated with this data import connection, the application displays a second confirmation message c click ok the application removes the service or service reference and its name no longer appears on the list to edit a service reference, do the following a click the expand icon next to the name of a service to expand the list of service references associated with it b click the edit icon next to the service reference to edit the application displays the edit service reference dialog box c modify the following information as needed field description external bo name or integration name automatically populated and cannot be changed contains the name of the business object that the service reference is associated with, or the name of the integration service reference the name of the service reference either enter a name or select a service reference from the drop down list (populated from the entries in the wsdl and script repository workspace) service address (url) or wsdl description the service address url if you selected an entry from the wsdl and script repository workspace for the service reference field, the application changes the name of this field from service address (url) to wsdl description and automatically populates this field use global constants for login and password specifies if the login and password information are global constants if you check this option, you must create the login and password global constants before you can use them see using global constants to hide login id and password information docid\ mirdh rhcg0jei2i56fmm login the login id used to log in to the service reference either enter a value (if you did not check use global constants for login and password ) or select a value from the drop down list (if you checked use global constants for login and password ) password the password used to log in to the service reference either enter a value (if you did not check use global constants for login and password ) or select a value from the drop down list (if you checked use global constants for login and password ) d click save adding an incoming service from the configuration console, click extend > integration tools > web service connections (beta) to open the web service connection manager (beta) workspace under the calls from external web services to system (incoming) section at the bottom of the page, click new service the application displays the integration page enter information into the fields field description integration name a unique name for the incoming web service connection description a brief description response xml (optional) contains a message to display used if an associated service reference does not have response xml defined click next the application displays the integration script page enter information into the fields field description service reference select a service reference from the drop down list, or click add new\ to add a new service reference see adding an incoming service reference docid\ j7tnsjafp3ohqrnokepmv request data the request data sent from the external application to get the request data, go to the external application and send an http request to the service address from the service reference that you just created after the application receives the request, the application displays it in this field script snippet a application generated script snippet the script displayed here is based on request data this information is displayed to help you create the script; however, this information is not the actual script the actual script to be used is displayed in the scripts field scripts the script that is executed copy and paste it from the script snippet or click append to populate this field see sample script docid\ j7tnsjafp3ohqrnokepmv for a sample script the maximum configurable web script statement limit has been increased to 250,000 in on premises environments the default limit remains 100,000 as does the maximum limit in the cloud click save adding an incoming service reference you can have one or more service references for each integration you can create new service references either from the main web service connections (beta) page or from the integration script page, which is the second page you see when creating an incoming service from the configuration console, click extend > integration tools > web service connections (beta) to open the web service connection manager (beta) workspace highlight an existing service under the calls from external web services to system (incoming) section at the bottom of the page click new service reference the application displays the create service reference dialog box enter information into the fields field description integration name automatically populated contains the name of the business object that the service reference is associated with, or the name of the integration service reference the name of the service reference either enter a name or select a service reference from the drop down list (populated from the entries in the wsdl and script repository workspace) service address (url) the service address url the url must be in the following format https // heat sm server port /inboundwebservice/ tenant url / web service page asmx an example is https //heatdev solys local/inboundwebservice/heatdev/servicetest asmx note if you are configuring the dsm integration, we highly recommend that you use the dsm integration workspace instead of this workspace see configuring the new dsm integration docid\ x0r5tiz6qouj7r9ii2xys for information click save testing the incoming web service connection follow these steps to test an incoming web service connection that you have already created (see adding an incoming service reference docid\ j7tnsjafp3ohqrnokepmv ) before you begin, do the following create an incoming web service connection, including a service reference see adding an incoming service docid\ j7tnsjafp3ohqrnokepmv and adding an incoming service reference docid\ j7tnsjafp3ohqrnokepmv add the client ip address into the list of trusted hosts see setting the trusted ip addresses docid 7lsl3wro0zatll81sdrsy for information follow these steps to test the incoming web service connection install the postman tool see https //www getpostman com/ https //www getpostman com/ for more information from the get drop down list, select post in the enter request url field, enter the service address url and add the api key at the end for example, enter https //heatdev solys local/inboundwebservice/heatdev/servicetest asmx?apikey=e076bd94d61f4141b16ffa88d0e0a45c see configuring the api key docid 7lsl3wro0zatll81sdrsy for information about api keys and how to generate them click body , and then select enter raw enter the following \<?xml version="1 0"?> \<inboundwebservicetest>this is a test\</inboundwebservicetest> using the postman tool click send the application should display the response text that you entered in the response xml field working with outgoing web service connections viewing, editing, cloning, and deleting incoming web service connections docid\ j7tnsjafp3ohqrnokepmvadding an outgoing web service connection integration docid\ j7tnsjafp3ohqrnokepmvadding an outgoing external business object integration docid\ j7tnsjafp3ohqrnokepmvadding an incoming service reference docid\ j7tnsjafp3ohqrnokepmvtroubleshooting time out issues docid\ j7tnsjafp3ohqrnokepmv viewing, editing, cloning, and deleting outgoing web service connections from the configuration console, click extend > integration tools > web service connections (beta) to open the web service connection manager (beta) workspace web service connections (beta) workspace the web service connection manager (beta) workspace has two sections outgoing and incoming (see working with incoming web service connections docid\ j7tnsjafp3ohqrnokepmv ) the outgoing web services section contains the following fields field description calls from ivanti to external web services (outgoing) integration the name of the web service connection click on the expand icon to the left of the name to expand the integration and see any associated service references service reference a web service name that the integration (connection) can access each integration can have one or more service references associated with it url the web service address user the user id used to access the web service to edit an existing integration or external business object integration, click the edit icon next to its name to clone an existing integration or external business object integration, including all of its service references, do the following a click the clone icon next to its name b in the confirmation message, click ok the application displays the new integration or external business object integration in the list to run an integration or external business object integration, click the run icon next to its name this submits the web service job for processing to activate or deactivate an integration or external business object integration, click the activate toggle icon next to its name this makes the web service connection active or inactive when it is inactive, the application cannot process the web service to delete an integration, external business object integration, or service reference, do the following a click the delete icon next to its name b in the confirmation message, click yes if there are any mappings associated with this data import connection, the application displays a second confirmation message c click ok the application removes the integration, external business object integration, or service reference and its name no longer appears on the list to edit a service reference associated with an integration or external business object integration, do the following a click the expand icon next to an integration or external business object integration to expand the list of service references associated with it b click the edit icon next to the name of the service reference to edit the application displays the edit service reference dialog box c modify the following information as needed field description external bo name or integration name automatically populated contains the name of the business object that the service reference is associated with, or the name of the integration service reference the name of the service reference either enter a name or select a service reference from the drop down list (populated from the entries in the wsdl and script repository workspace) service address (url) or wsdl description the service address url if you selected an entry from the wsdl and script repository workspace for the service reference field, the application changes the name of this field from service address (url) to wsdl description and automatically populates this field use global constants for login and password specifies if the login and password information are global constants if you check this option, you must create the login and password global constants before you can use them see using global constants to hide login id and password information docid\ mirdh rhcg0jei2i56fmm login the login id used to log in to the service reference either enter a value (if you did not check use global constants for login and password ) or select a value from the drop down list (if you checked use global constants for login and password ) password the password used to log in to the service reference either enter a value (if you did not check use global constants for login and password ) or select a value from the drop down list (if you checked use global constants for login and password ) d click save adding an outgoing web service connection integration from the configuration console, click extend > integration tools > web service connections (beta) to open the web service connection manager (beta) workspace click new integration the application displays the integration detail page web service connections (beta) setup sequence enter information into the fields field description integration name a unique name for the integration description a brief description click next the application displays the integration script page enter information into the fields field description service reference select a service reference from the drop down list, or click add new\ to add a new service reference see adding an incoming service reference docid\ j7tnsjafp3ohqrnokepmv web service list displays the available web services from the service reference url choose a web service from the drop down list method list displays the available methods from the selected web service list choose a method from the drop down list this is displayed to help you create the script method input the input parameters for the method the information displayed here is based on the method that you select this information is displayed to help you create the script; however, this information is not the actual script the actual script to be used is displayed in the scripts field method output & return value the output and return values for the method the information displayed here is based on the method that you select this information is displayed to help you create the script; however, this information is not the actual script the actual script to be used is displayed in the scripts field script snippet an application generated script snippet the information displayed here is based on the method that you select see sample script docid\ j7tnsjafp3ohqrnokepmv for a sample script this information is displayed to help you create the script; however, this information is not the actual script the actual script to be used is displayed in the scripts field scripts this is the script that is executed copy and paste it from the script snippet or click append to populate this field see sample script docid\ j7tnsjafp3ohqrnokepmv for a sample script the maximum configurable web script statement limit has been increased to 250,000 in on premises environments the default limit remains 100,000 as does the maximum limit in the cloud adding a web service connection integration click next the application displays the schedule page for information about using the schedule page, see setting the data import or web service connection schedule docid\ z8kdisu8gjfwjewthqcuk click next the application displays the review and publish page for information about using the review and publish page, see reviewing and publishing import or web service connection data docid\ z8kdisu8gjfwjewthqcuk sample script the following is a sample script that can be used when creating a web service connection integration // // demo integration script // // prepare service call console info("script starts demo integration internal service address frsheatintegration getrolesforuser"); var wsdladdress = "demo integration internal service address"; var userid = "demo integration internal service login"; var pwd = "demo integration internal service password"; var servicecall = "frsheatintegration"; var serviceinstance = getwebservicefromurl(wsdladdress,servicecall, "", ""); var tenantid; var sessionkey; var authresponse = serviceinstance invokemethod("authenticateuser", \[userid, pwd, tenantid]); if (authresponse authenticationstatus != "success") console info("script error access denied demointegration internal service address frsheatintegration getrolesforuser"); else { // call web service sessionkey = authresponse authenticationsessionkey; console info("script executes demo integration internalservice address frsheatintegration getrolesforuser"); var methodcall = "getrolesforuser"; var paramvalues = \[sessionkey, tenantid ]; // result "hover" on "script snippet" or "script" label for info var result = serviceinstance invokemethod(methodcall, paramvalues); console info("script result " + result rolelist\[0] name + "demointegration internal service address frsheatintegration getrolesforuser"); } see web service methods docid\ qociljcfllhuopxuwihvd for more information adding an outgoing external business object integration before you add an external business object integration, you must create an external business object (see creating a stand alone business object docid\ prrpnuvje8dmzc oaqymn ) and add the new business object to a role (see defining top level tabs docid\ rw3tvl9kqwmniw3mxhalp ) from the configuration console, click extend > integration tools > web service connections (beta) to open the web service connection manager (beta) workspace click new external bo integration the application displays the integration detail page in the external bo name field, select the external business object that you created and optionally add a description in the description field click next the application displays the integration script page enter information into the fields field description service reference the web service to use with the external business object select a service reference from the drop down list, or click add new\ to add a new service reference see adding an incoming service reference docid\ j7tnsjafp3ohqrnokepmv web service list the available web services from the service reference url choose a web service from the drop down list this provides the mechanism for communicating with the external application method list the available methods from the selected web service list choose a method from the drop down list this is displayed to help you create the script method input the input parameters for the method the information displayed here is based on the method that you select this information is displayed to help you create the script; however, this information is not the actual script the actual script to be used is displayed in the scripts field method output & return value the output and return values for the method the information displayed here is based on the method that you select this information is displayed to help you create the script; however, this information is not the actual script the actual script to be used is displayed in the scripts field script snippet an application generated script snippet the information displayed here is based on the method that you select see sample script docid\ j7tnsjafp3ohqrnokepmv for a sample script this information is displayed to help you create the script; however, this information is not the actual script the actual script to be used is displayed in the scripts field scripts the script that is executed to feed the external data into the script uses java script and does not support browser based elements copy and paste it from the script snippet or click append to populate this field see sample script docid\ j7tnsjafp3ohqrnokepmv for a sample script click next the application displays the schedule setting page for information about using the schedule page, see setting the data import or web service connection schedule docid\ z8kdisu8gjfwjewthqcuk click next the application displays the review and publish page for information about using the review and publish page, see reviewing and publishing import or web service connection data docid\ z8kdisu8gjfwjewthqcuk adding an outgoing service reference you can have one or more service references for each integration you can create new service references either from the main web service connections (beta) page or from the integration script page from the configuration console, click extend > integration tools > web service connections (beta) to open the web service connection manager (beta) workspace highlight an integration click new service reference the application displays the create service reference dialog box enter information into the fields field description external bo name or integration name automatically populated contains the name of the business object that the service reference is associated with, or the name of the integration service reference the name of the service reference either enter a name or select a service reference from the drop down list (populated from the entries in the wsdl and script repository workspace) service address (url) or wsdl description the service address url the url must be in the following format https // heat sm server port /inboundwebservice/ tenant url / web service page asmx an example is https //heatdev solys local/inboundwebservice/heatdev/servicetest asmx if you are configuring the dsm integration, we highly recommend that you use the dsm integration workspace instead of this workspace see configuring the new dsm integration docid\ x0r5tiz6qouj7r9ii2xys for information use global constants for login and password specifies if the login and password information are global constants if you check this option, you must create the login and password global constants before you can use them see using global constants to hide login id and password information docid\ mirdh rhcg0jei2i56fmm login the login id used to log in to the service reference either enter a value (if you did not check use global constants for login and password ) or select a value from the drop down list (if you checked use global constants for login and password ) password the password used to log in to the service reference either enter a value (if you did not check use global constants for login and password ) or select a value from the drop down list (if you checked use global constants for login and password ) click save troubleshooting time out issues the following troubleshooting tip is for on premise customers only and does not apply to cloud customers starting in release 2016 2, if your application times out while working with web services, you can change the settings in the app config file located at \program files\heat software\heat\integrationserver\integrationservicehost open the file with a text editor and update the following settings, which are both measured in seconds \<appsettings> \<add key="scriptactionhostsendtimeoutseconds" value="180" /> \<add key="scriptactionhostreceivetimeoutseconds" value="300" /> \</appsettings>