Skip to main content

Sharing a Project

OutSystems

Sharing a Project

 

What project formats are accepted?

 Currently you can share your work in one of three distinct project formats:

1. OutSystems application package (.oap, oap) 
 - Maps directly to an application in the OutSystems platform.
 - Allows automatic application installation with dependency management.
 - Ensures that packages that are installed have no impact in your environment.
 - Ideal for ready-to-run content like applications and components.
 - Is available only from Platform 9 and up.

2. OutSystems module (.oml, .xif)
 - Maps directly to a module in the OutSystems platform.
 - Allows fast module access for code inspection and reuse.
 - Is ideal for code samples and snippets.

3. OutSystems solution package (.osp)
 - Allows multiple modules to be packaged into a single file.
 - Is installed via the environment management console.

 

What project format should I use to share my work?

You can use OutSystems application packages (.oap) to share fully functional applications or components that will benefit from the OutSystems automatic installation and dependency management capabilities, thus providing the best possible experience for others in the Community.

If what you want to share is a simple component or snippet (e.g., a how-to, a coding pattern, a small widget) that is not ready-to-run on its own, sharing a single module is the way to go. This will allow other users to easily open and inspect its content for reuse.

If you’re still working with a release prior to OutSystems Platform 9, and you want to share a complete application, you should continue to use the OutSystems Solution Package format until you upgrade.

 

How do I export an OutSystems Application Package for sharing?

Open the Application in your development environment, click the Environment menu entry, select Application Management... and then, on the page that loads click the Download button.

 

How do I export an OutSystems Module for sharing?

Open the module in your development environment, click the Module menu entry, select Module Management... and then, on the page that loads click the Download Published Version button.

 

How do I publish a component?

If you think your component can help other developers, consider publishing it.

For the most part, components in Forge are distributed under the BSD license, but some components or plugins have different licensing models that can have different requirements, like attribution in the app. Check your compliance with third-party licenses.

For more information about creating components, check the Complete Guide to Creating Components.

Demo module

To prepare your component for publication, add one new module to the application, with a demonstration of the most common use case. Its name should include the component's name and "Demo" or "Example" since users will search for the component's name when they need help.

This demo should be guided and straightforward with one single or central screen (if possible) and without a login.

Forge Publication

Once your component is ready, follow these steps to prepare and publish your component to the Forge:

  1. Manage dependencies to remove all unused elements and ensure the final eSpace module (.oml) is not too big. If it is, consider compressing any used image files or resources.
     
  2. Go to Service Center and download your component. If possible, you should download it as an application (.oap), but the Forge supports the module or eSpace (.oml) format as well.
     
  3. Log into the Forge and click Publish New Project.
     
  4. Select the component file you downloaded in step 1. If applicable, the Forge will warn you of any dependencies.
     
  5. Continue to edit your component's details. By default, the name, icon, and descriptions are the ones defined during the development of your component. These descriptions can be changed even after publication.
     
  6. Add images or screenshots (500/600 px x 200 px) that best illustrate your component's features and the main use cases and behavior.
     
  7. In the preview URL, enter the URL that will feed Try Now. This URL should link to sample, demo, or tutorial screens that can also be made available inside the downloadable module. Your link should be hosted in a public server, such as a personal environment.
     
  8. Select at least one category that best matches what your component is. This categorization will help users to find your component.
     
  9. Enter the project version. These numbers are unique. The Forge will suggest one, but you can change it. Since this number will be visible in the versions of your component, each new version update should be an incremental number, so people can instantly recognize it as the most recent version.
     
  10. The stable checkbox exists to allow unfinished or untested projects. However, if your component is finished, with all features completely implemented and fully tested and with the best performance possible, then you should let other users know and check Stable.
     
  11. Under requirements, the Forge suggests a platform version. You can also select the supported database and supported stack. This will help users know if they meet all the conditions to download and use your component.
     
  12. Add any relevant tags. They help users find your component and can be used to filter published components.
     
  13. Enter the detailed description of your component. Make sure it fully describes your component's features and options. Your descriptions should be clear and explain use cases and behavior.
     
  14. Click Publish and enjoy your success!
  • Was this article helpful?