Configure the Custom Uploader
For background information, see Custom Uploader.
If you want to create a Custom Uploader, then please Contact Sales to obtain the source files that you will need.
This document describes how you can configure your personalized Custom Uploader. This allows you to use a reserved area of the ScreenPal Solution Builder Upload UI panel to insert your custom UI. You create the UI using the Java programming language (not JavaScript).
In this screenshot, the yellow rectangle is the area where your custom Java user interface would appear.
![Document image Document image](https://images.archbee.com/xEUJizVl5AzmsuYHApVcv/J3fqNQ3YpT0pzfdQtn-hN_image.png?format=webp)
Your custom user interface can be used to add additional customer entered information that is delivered in the POST to the upload URL.
Create a Java source file, such as CustomPublishImpl.java, that implements the com.screencastomatic.custompublish.CustomPublish interface. For example:
You create a JAR file, similar to BasicUploadSkin-x.y.z.jar, that replaces BasicUploadSkin-x.y.z.jar. Inside that JAR file, you put:
- The class file for your custom uploader, such as CustomPublishImpl.class. Make sure to put it inside the required Java directory hierarchy, such as "test/custompublish/CustomPublishImpl.class" for the example source file above's Java package.
- You "appDisplay.properties" file with your customized properties. See appDisplay.properties section for a description of the properties you can use.
- Any resources you need for you custom UI, such as skin images.
Be sure to remove BasicUploadSkin-x.y.z.jar and use your custom uploader JAR, such as CustomUploadSkin-3.1.0.jar, when specifying your list of JARs that get downloaded from your JavaScript launcher properties. See JAR File Names.
Below is a list of properties that you may configure from your Basic Uploader JavaScript file, and/or your CustomUploadSkin-x.y.z.jar JAR file (inside its appDisplay.properties and appDisplay_xxx.properties files.)
The ScreenPal application displays text using localization. This means it detects the user's set language and choses a string created for that language. It does this by having the text property being placed in a language specific file. For example, put the "som.*.app.preview.title" property in each of the language files, with its value text set to the translated string for that language.
appDisplay.properties is used to hold properties that are for any language, such as properties that are not text messages. appDisplay_xxx.properties files are used to hold language specific strings.
In the property list below, LOCALE is used to identify a property that you should place in a language specific appDisplay_xxx.properties file.
Filename | Language | Note |
appDisplay.properties | None. | Holds non localized properties. (No translated text.) |
appDisplay_de.properties | German | |
appDisplay_default.properties | English | Used as the default when no other language file contains an overriden property. |
appDisplay_es.properties | Spanish | |
appDisplay_fr.properties | French | |
appDisplay_it.properties | Italian | |
appDisplay_ja.properties | Japanese | |
appDisplay_pt_br.properties | Portugues (Brasil) | |
appDisplay_zh.properties | Chinese | |
The following properties can be set in the appDisplay.properties file:
REQUIRED LOCALE The subdirectory to store your users’ recordings. The subdirectory is created in the ScreenPal Application's default storage location. For example, the user's home folder on Mac, or the user's documents folder on Windows.
REQUIRED Identifies the Java class you created that implements the CustomPublish interface.
REQUIRED LOCALE The text to show for your brand name.
OPTIONAL Optionally show the Show Draw & Zoom Controls button on the ScreenPal Recorder.
OPTIONAL Optionally show the Edit Video button on the Upload UI panel.
REQUIRED LOCALE The text to show on the ScreenPal Application titlebar.
REQUIRED LOCALE The text to show for the title of the recording at the top of the Preview display.
OPTIONAL Specifies if the local recording should be deleted after a successful upload.
REQUIRED LOCALE The message to display after a successful upload. The optional string, TITLE_REPLACE, will be replaced with the string you return from your CustomPublishImpl.getTitle() Java method.
OPTIONAL After a successful upload, a Continue button is displayed. When clicked, a webpage will be opened to the URL you specify here. If not specified, then no webpage is opened. Specify gotoplayback to open the URL you returned for a successful upload via com.screencastomatic.CustomPublish.CustomUploader.Listener.done(String url).
OPTIONAL After a successful upload, you can choose to show UI that presents a hyperlink URL to open the video or use its Copy button to copy the URL to the clipboard.