Permalink: www.outsystems.com/goto/howto-configure-integration-studio
Integration Studio is the Agile Platform tool you should use when making low level integrations. This tool allows you to connect with entities from other databases (through Service Center defined Database Connections) and also to define Actions whose operation is determined in "low level" Java or .NET code.
In this post I will guide you through what configurations are needed to allow you to correctly compile and develop Java or .NET source code in Integration Studio.
In the Edit -> Options Menu you will find a tab for each framework (J2EE and .NET) where you can configure the following options for each:
In order to be able to compile extensions with a certain Application Server type, you'll need to correctly configure the Compiler Tool (and possibly the options). In order to be able to Edit the Source code of an extension with a certain Application Server type, you'll need to correctly configure the Integrated Development Environment for that Application Server type.
What's required?
With these installed the default options in Integration Studio should work. You can always use Reset Settings to replace them.
In case the defaults don't work use the following:
Java SDK is installed normally; for ANT and Eclipse, simply download the ZIP file and extract them to a folder of your choice.
Regarding Eclipse, if you are using Windows Vista or 7 and have UAC enabled (the default) unzip eclipse to a folder outside "Program Files" - this will avoid privileges problems when writing to C:\Program Files\.
Suggestion: create a "C:\opt" folder and put both ANT and Eclipse in it (C:\opt\apache-ant-1.8.4 and C:\opt\eclipse).
To configure ANT and JAVA for Eclipse you need to create system environment variables for their installation paths.
The variables that need to be created are JAVA_HOME and ANT_HOME; for example, your JAVA_HOME could have a value of C:\Program Files\Java\jdk1.6.0_45 and your ANT_HOME could have a value of C:\opt\apache-ant-1.8.4.
After setting the environment variables, you need to perform the following configurations in Integration Studio (Edit -> Options):
Now you should be able to build .NET and Java extensions.
Happy Integrations !
If you have any questions related to this topic, feel free to ask them.
Best regards,
Ricardo Silva
Is there an update for the newer versions of Integration Studio? I was able to figure it out again, but it looks like the inputs have been changing.
Hello Rebecca,
Nothing changed for .NET, and Java simply added the possibility to define the Java Home.
I'll update the original post to cover for that.
Hi, I'm trying to configure Integration Studio for Java/J2EE but a couple of problems ...
1) the link for creating system environment variables results in the error "Payment required"But I found another site that explained it to me.
2) skipping that part, the following error occurs after having installend ANT and Eclipse and trying to apply the configurtaion:
This is how my Eclipse installation directory looks like ...
By the way ... I had to choose which package of Eclipse to download ... I chose the first one, the Java EE version.
I deleted the (unpacked zip) installation of Eclipse, re-installed eclipse using the installer, and tried again to configure Integration Studio for J2EE / Oracle ... same result .., "Error copying Integration Plugin into Eclipse plugin directory".
Please help!
Hi Charley,
Can you try by running Integration Studio as administrator to see if it helps?
Also, in this last installation does it also have a "plugins" folder there?
Regards,
João Rosado
Hi Joao, thnx for replying.
Just solved the problem myself ... I had to specify the full path to eclipse, including eclipse.exe, and also the full path to the ant.bat file ... my first tries were the path names without the filenames themselves.
Working now, and successfully created my fist extension :-)
Charles Betman wrote:
Hi,
Had a similar issue where the integration studio would say that the configuration was not correct. Your solution helped me because i also had the specification for the ant_home up to the bin and not with the bat file.
Specified the full path to the eclipse, java and ant bat file and started working.
Best regards
I have set everything up as said in the instruction but when I try to open the java code for editing, no project opens up in the eclipse, only eclipse shows up. I don't get any errors or anything and if I try to open the project directly from folder in eclipse, then after writing the code when I close the eclipse or publish the extension, all of the code that I have written gets deleted. Any Idea what could be causing this?
Note: I'm using Eclipse Neon and my Integration studio version is 9.1.6
Hi Gurvinder,
I am having the same problem. Do you manage to fix this issue?
Myles
Gurvinder Singh wrote:
Myles Chippendale wrote:
I managed to fix this by re-installing eclipse.
I had originally installed the "Eclipse IDE for Java Development" version of Eclipse Mars using an eclipse installer. I then downloaded the "Java EE Development" version of Eclipse Mars, the version that you just unzip. After changing the path to my eclipse in Integration Studio, it worked.
So from what I tested and here are some problems that can cause the "plugin" problems and how to fix them.The differences depend on either: eclipse version, installation folder, what eclipse type installed or how it was installed (via installer or zip)
Cause 1: Eclipse is installed in the Program Files and integration Studio cannot install the plugin it needsSymptoms: There is no error closing the preferences window, but eclipse opens without a projectSolution: Run Integration studio in Administrator Mode and change the eclipse path in the preferences window. Check if inside the eclipse folder there is a "\plugins\outsystems.integration.plugin\" directory created after that
Cause 2: Eclipse is configured to not use its own folder as Data Folder.Symptoms: Either there is no "\plugins\" folder and Integration Studio gives an errorSolution: Create a "\plugins\" folder inside the eclipse directory, change the eclipse path in the preferences window. Check if inside the eclipse folder there is a "\plugins\outsystems.integration.plugin\" directory created after that
Regardless of what issue it was, if there is still no project inside eclipse after it opens, then go copy the "outsystems.integration.plugin" directory from "\plugins\" to "\dropins\"
Tell me if it any of these solutions works for you.
Regards,João Rosado
João Rosado wrote:
Regards,João Rosado
These notes should definitely be moved into the main post.
Can any other IDE for .NET be used besides Visual Studio? I tried to use SharpDevelop put every time I apply the configurations this popup comes up:
My configurations are the following:
Thanks for the help.
André
Hi André,
Unfortunately no, you can't use any other IDE for .NET besides Visual Studio. According to OutSystems Platform system requirements (https://success.outsystems.com/Support/Enterprise_Customers/Installation/OutSystems_Platform_system_requirements), you'll need Visual Studio 2013 or higher, to edit the source code of Extension Actions. I don't really know the deep details, but I believe it has to do with how Integration Studio generates all your project structure and configurations which are aimed solely for a Visual Studio project.
Kind regards!
Pedro Gonçalves wrote:
Hi Pedro,
Thanks for the quick reply ;)
I wanted to know if the programming language chosed for the Extension has to match with the server platform framework installed. For exemple my server platform is supporter in .Net and I try to create a java extension. Is this possible?
It's not true. I did use the SharpDevelop recently.
[edited] Sorry, but it is not possible to include a stack's code (e.g. Java) in an extension and publish it in another platform installation's stack (e.g. .NET), due to an Integration Studio validation (e.g. Invalid Extension error)
If you are publishing a double-stack extension (Integration Studio > Extension properties > Application Server: Both) then you may be able to publish that extension yes, however the uninstalled stack will never be executed on that platform installation. This is a common case with double-stack extensions that are included in the platform (e.g. System Components) and others you may find in the Community Forge - only the respective stack code that matches the platform installation will actually be executed.
Hoped I clarified your question!
Regarding the IDE question, you can actually use any Visual Studio compatible IDE, but you won't be able to configure it in the preferences.
After compiling your extension once you can locate the folder that is created in the disk next to the .xif file and open it in your prefered IDE.
The important is that the .NET project files (.sln and .csproj) are still correct after using other IDE (thats why I said compatible IDE), as Integratoon Studio will use them to compile.
Same also applies to Java ...anyone is free to import the project manually in other IDEs like Intellij, the platform will use the Ant build.xml to compile, so as long that ia correct it will work. But for example in this case Intellij will not update the eclipse .project file ...so if other developer goes and tries to edit that extension in eclipse he may not have a correct eclipse project configuration.
So, use them at your own responsibility :)
My personal recommendation is to stick with the latest versions of the officially supported IDEs.
Regard,
Ricardo Silva wrote:
Hi Ricardo,
What if I don't need Java because I am not writing Java extensions? Integration studio tells me that options are not correctly defined and asks me to setup up options for java environment. But I don't have cause I don't use and I don't want to install it.
In that case you need to set your extension to be ".NET Only".
You can do that by selecting the extension name and on the right pane you have the option to say it's for .net stack only
Thanks, got it.
So, maybe have a better error message? You know, one that actually tells what's wrong so as we can have an idea on how to correct the problem?
It's not like Integration Studio doesn't know what's wrong, so why not tell the user?
Hi, I'm using Integration Studio 9.1.301, with JDK 1.8.0_72. I created an empty extension and when I compile I got the following error. Can anyone please see what cause this is? (Original screenshot attached). Thanks.
Hi, while configuring i am getting the error..
Thanks
Rajendra Singh
The objective is not for those to be necessary steps. If all goes well, the next revision (at least for 10.0) should work correctly without the workaround.
Cool! With the current revision at least one step I had to do manually was to copy the plugin to the dropins folder.
Hello,
I tried to publish my extension and it gives me error that there is no jar file found on the directory?
Can somebody help me pls?
Hi All,
I was trying to configure Eclipse with my Integration studio but i am getting popup box
saying
Please do let me know what wrong i am doing here.
Ity Sharma
Ity Sharma wrote:
Hi Ity,
That warnin pop-up if if the application server is set to both and you do not have the .NET settings set.
Set to J2EE and see if it works:
Hope it helps you.
Hey Guys,
So I'm using the Service Studio version 10.0.717.0 and the Platform server 10.0.710.0, our projects only are in .Net architecture (VS 2017) on Windows 10.
When I try to open an XIF, the Integration start and stores an error that calls feedback and close his window.
My Steps:
Points that may considerate:
When I always need use the Integration Studio with Service Studio, will be necessary run as administrator both?I try to use the Visual Studio Code and didn't work, so now I use the Visual Studio 2017. There will be enable some feature for work with Visual Studio Code?
Why Integration Studio doesn't leaves me set the path of .Net Integrated Development Enviroment? if I'm not running as administrator.
Hi Marcel,
It is true that you need to run Integration Studio as administrator When you want to change the configuration. What you deactiveren sounds like a bug, but most developers I know don’t have it, because they are local admins. you can report the bug to OutSystems support via their website and for the time being run Integration Studioas administrator.
Remco Dekkinga wrote:
It is true that you need to run Integration Studio as administrator When you want to change the configuration. What you deactiveren sounds like a bug, but most developers I know don’t have it, because they are local admins. you can report the bug to OutSystems support via their website and for the time being run Integration Studioas administrator.
Tks Remco I will do that
Hi Guys!
I can't seem to edit the .NET source code it keeps on saying this:
I have not configured J2EE. Do I need to configure that too? It seems in the comments that there is no need but I keep on having this problem. How do I fix this?
Thank you.
Hi Michael,
If you want to build an extensions for both .net and Java, you need to configure both. If you are only building your extension for .net, you only need to configure the .net environment.
Next to this configuration, you have to set your extension to be available for only .net instead of both (Java & .net). You can do this in the main screen on the details of your module.
Thank you. I think I have already done that. Here, check these out:
Was there something I missed?
These settings are correct. If you stil get the error, you need to make call with OutSystems support, because it seems you hit a bug that needs to be identified.
I see. I will do that. Thank you.
Hi, I am trying to configure .NET and I have downloaded Visual Studio 2017. However, whenever I attempt to apply change to the option, the system error pops up and shut down Integration Studio immediately, so I cannot make any changes even though I know what to change. Can anyone help me regarding this issue?
Dol Hee Kim wrote:
Hi, I get the same error when trying to configure .NET and Visual Studio 2017 community version.
Hi Dol Hee Kim and Stefan Swanepoel,
First of all, I'm sorry you had this problem. We are analyzing and trying to reproduce it, I'll get back to you when we have more information.
Meanwhile, you can try something to see if it solves the problem: delete the file "%AppData%\Roaming\OutSystems\Integration Studio\IntegrationStudio.Preferences". Attention: this will clean your recently open extensions and environments list.
Pedro Guimarães
Hi There,
I am getting below issue, please help
Seetharam Phanindra Maringanti wrote:
I don't see any below issue. Please open a new topic instead of adding more things to this one.
Please please please answer what the Compare files with option is for, and what to specify? The documentation has a circular trio of pages that try to explain it which fail miserably at providing clarity!
Lars Berntrop-Bos wrote:
I never used that option, so I just keep it empty and I'm able to create my extesions without issues.
But what is it for? That is not answered...
I never saw any documentation on it, but as far I can tell, this option allows you to compare the .net latest version with the template file - template here means the files automatically generated by the platform.
If you go to the Resources tab on Integration Studio, you can right click on one of the .net files and do compare with template.
It will open and compare the latest version with the template version, using the tool you selected in the configuration. You may test it with notepadd++, it opens both versions. Or you may use a real compare tool, such as Beyond Compare, which automatically tells you the differences.
The only use case I see for this is, if by mistake some of the platform code is deleted, and you want to revert it, otherwise the extension may not work. But, as I mention, I never had the need to used it in all my years of OutSystems.
Thanks to all of you guys, I'm transitioning from .Net to Outsystems platform and having lots of doubt for integration, this thread clear most of my doubt.
Sanjay