About Unpacking and Copying Plugin Resources

Note
 This information applies to plug-ins that are not Sabre Scribe scripts. If you want to automatically copy resources from a Sabre Scribe scripts plug-in, see About Sabre Scribe Scripts.

You can automatically unpack and copy files from your plug-in to Sabre Red 360 on the first run of a plug-in. You also have the option of unpacking files every time you have an updated version of your plug-in.

This mechanism is applicable to plug-ins that are local web page apps. These web page apps are extracted locally without server-side functionality. The web apps can be embedded as an editor or a view.

You can use this for websites that are run locally, and not run from a plug-in JAR.

To point to files within a plug-in, add the com.sabre.edge.redapp.pluginresources extension point to plugin.xml, specify the files to be accessed, and set an override flag to either retain the existing or first-version of files, or override existing files with a new version. In both cases, include a definition to the path where the files are located in the plug-in project. This enables access to the files when end-users run your Red App.

You can add this functionality to any plug-in within your Red App bundle, however, it is not recommended to share resources among plug-ins.

Add this functionality when:

  • You want to publish a first version or an updated version of a plug-in in which you have updated the files to copy to Sabre Red 360.

  • Your plug-in is a web app that is wrapped as an editor or a view, using the DefaultWebkitEditor class or the WebkitView class, without Java code.

  • You have a web address that you want to access or update.

  • You need to access locally stored resources that cannot be used inside a JAR file.

  • You need a place to store and update the content of your files or information during runtime.