Skip to content
/ BridgeSamples Public

CEP Extension Samples and documentation for Adobe Bridge CC

5 stars 1 fork Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

siddharthsingh89/BridgeSamples

BranchesTags

Repository files navigation

CEP now supported by Bridge!

Common Extensibility Platform CEP (formerly CSXS - Creative Suite Extensible Services) is a shared technology which provides a rich platform to create and run HTML5-based extensions across point products. The extensions created using CEP framework, extend the functionality of the host application(eg. Bridge, PhotoShop) that they run in, using HTML5, JavaScript, ExtendScript, and CSS.
Bridge is now supporting CEP and Users can create CEP extensions for Bridge as well.

Get started with development.

What all is needed

Steps

  • Download\Clone the repository.
  • Add PlayerDebugMode setting for quick testing of unsigned applications during development. Refer to Debugging section  below for detailed instructions.
  • Copy the samples to <CEP Extension folder> and Update it as your own extension. Refer to Extension Folders section below for CEP Extensions locations on Win and Mac.
  • Launch Bridge and Go to Window Menu -> Extensions and you can find the list of extensions there.
  • Sign and package the Extension.

What's different in Bridge vs Other Point Products

Extension Types Supported By Bridge

Currently there are three types of CEP extensions that can be created - Embedded, Modal Dialog, Modeless Dialog.

The Embedded type of extension behaves like any other application panel. It can be docked, participates in workspaces, has fly-out menus, and is re-opened at start-up if open at shutdown. The corresponding type identifier in the extension manifest is Embedded.

The Modal Dialog type opens a new window and forces the user to interact with the window before returning control to the host application. The corresponding type identifier in the extension manifest is ModalDialog.

The Modeless Dialog type opens a new window but doesn't force the user to interact with it. The corresponding type identifier in the extension manifest is Modeless.

 

CEP Runtime 

Bridge will support CEP 8.0

Important Manifest Changes for Bridge CEP Extensions

  • Correct ExtensionManifest Version should be used in the manifest.

    <ExtensionManifest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ExtensionBundleId="com.adobe.Samples2" ExtensionBundleVersion="1.0" Version="7.0">

  •  Make sure to use the correct HostID and point product version for Bridge in the manifest.xml of the extension.

    <HostList>
    <Host Name="KBRG" Version="[8.0,8.9]"/>
    </HostList>
    eg. This will support Bridge version 8.0 up to, and including, 8.9.

  • Make sure correct CEP runtime version is used.

    <RequiredRuntimeList>
    <RequiredRuntime Name="CSXS" Version="7.0"/>
    </RequiredRuntimeList>

Important Manifest Changes for Bridge CEP Extensions

  • Correct ExtensionManifest Version should be used in the manifest.

    <ExtensionManifest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ExtensionBundleId="com.adobe.Samples2" ExtensionBundleVersion="1.0" Version="7.0">

  •  Make sure to use the correct HostID and point product version for Bridge in the manifest.xml of the extension.

    <HostList>
    <Host Name="KBRG" Version="[8.0,8.9]"/>
    </HostList>
    eg. This will support Bridge version 8.0 up to, and including, 8.9.

  • Make sure correct CEP runtime version is used.

    <RequiredRuntimeList>
    <RequiredRuntime Name="CSXS" Version="7.0"/>
    </RequiredRuntimeList>

Sample Manifest XML for Bridge 

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ExtensionManifest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ExtensionBundleId="com.adobe.Samples" ExtensionBundleVersion="1.0" Version="7.0"> 
    <ExtensionList>
        <Extension Id="BridgeHelpPage" Version="1.0"/>  
			
    </ExtensionList>
    <ExecutionEnvironment>
        <HostList>
            <Host Name="KBRG" Version="[8.0,8.9]" />
        </HostList>
        <LocaleList>
            <Locale Code="All"/>
        </LocaleList>
        <RequiredRuntimeList>
            <RequiredRuntime Name="CSXS" Version="7.0"/>
        </RequiredRuntimeList>
    </ExecutionEnvironment>
    <DispatchInfoList>      
        <Extension Id="BridgeHelpPage">
            <DispatchInfo>
                <Resources>
                    <MainPath>./index.html</MainPath>		
					
                </Resources>
                <Lifecycle>
                    <AutoVisible>true</AutoVisible>
                </Lifecycle>
                <UI>
                    <Type>Embedded</Type>
                    <Menu>Bridge Help</Menu>
                    <Geometry>
                        <Size>
                            <Height>580</Height>
                            <Width>1020</Width>
                        </Size>
                        <MaxSize>
                            <Height>800</Height>
                            <Width>1200</Width>
                        </MaxSize>
                        <MinSize>
                            <Height>400</Height>
                            <Width>600</Width>
                        </MinSize>
                    </Geometry>
                </UI>
            </DispatchInfo>
        </Extension>
   
    </DispatchInfoList>
</ExtensionManifest>

 

Debugging the Extension


Using unsigned extensions during development

 If your Extensions is not signed, they will be displayed in the Bridge Extension list but appear as Blank without any functionality. If you are in the midst of development and want to bypass the need to sign your extensions, you can bypass the check for extension signatures by editing the CSXS preference properties file\registry entry.

Windows-

  1. Open Registry Editor.
  2. Go to  HKEY_CURRENT_USER/Software/Adobe/CSXS.8, then add a new entry PlayerDebugMode of type "string" with the value of "1".
  3. Relaunch Bridge.
  4. The Extension will work without signing.

Mac-

  1. In the terminal, type: defaults write com.adobe.CSXS.8 PlayerDebugMode 1
  2. Restart Mac and Launch Bridge.
  3. The Extension should work without signing.

(The plist is also located at /Users/<username>/Library/Preferences/com.adobe.CSXS.8.plist)

Debugging in Chrome

CEP supports remote debugging for HTML extensions. You can use Chrome developer tools to debug your Extension.

Steps:

1.Create a “.debug” file to the extension root directory such as Test_Extension\.debug.

The .debug file contains remote debug ports. Developers must create this file and use valid debug ports because both remote debugging and dev tools are based on it.

This file name is special for both Windows and Mac platforms, it has to be created via command line.

 On Windows, open cmd, go to the path of your extension and type  "copy con .debug" and "Ctrl+Z" to create an empty file.
 On Mac, use "touch .debug" to create an empty file.

 

2. Edit the .debug file and it should resemble the following (and the Extension ID must match the one in the panel's manifest). The value of Port should be between 1024 and 65535 (not include 65535), otherwise remote debugging and dev tools will not work.

<?xml version="1.0" encoding="UTF-8"?> 
<ExtensionList>
    <Extension Id="ShowFolder">
        <HostList>
           <Host Name="KBRG" Port="8888"/> 
        </HostList>
    </Extension>
</ExtensionList>

 

3. Launch your Application and open the Extension.Open Chrome and navigate to http://localhost:8888. Your Extension should be visible.

Logs locations

Log files with useful debugging information are created for each of the applications supporting CEP extensions. The platform-specific locations for the log files are as follows:

• Win: C:\Users\USERNAME\AppData\Local\Temp
• Mac: /Users/USERNAME/Library/Logs/CSXS

These files are generated with the following naming conventions:CEP<versionNumber>-<HostID>.log.Example- CEP7-KBRG.log

Logging levels can be modified as per the following levels:

• 0 - Off (No logs are generated)
• 1 - Error (the default logging value)
• 2 - Warn
• 3 - Info
• 4 - Debug
• 5 - Trace
• 6 - All

The LogLevel key can be updated at the following location (The application should be restarted for the log level changes to take effect):

• Win: regedit > HKEY_CURRENT_USER/Software/Adobe/CSXS.8
• Mac: /Users/USERNAME/Library/Preferences/com.adobe.CSXS.8.plist

Signing and Packaging the Extension


After testing your extension thoroughly, you must package and sign your extension so users can install it in their systems.

Adobe provides a command-line tool, ZXPSignCmd, that you can use to package and sign extensions so they can be installed in Adobe desktop applications. The signature verifies that the package has not been altered since its packaging.

You can use this tool to -

Create a self-signed certificate-
Example: ./ZXPSignCmd -selfSignedCert US NY MyCompany MyCommonName abc123 MyCert.p12

This generates a file named MyCert.p12 in the current folder. You can use this certificate to sign your extension.


Create a signed ZXP package-
Example: ./ZXPSignCmd -sign myExtProject myExtension.zxp MyCert.p12 abc123

This generates the file myExtension.zxp in the current folder, adding these two files to the packaged and signed extension in the final ZXP archive:
1. mimetype : A file with the ASCII name of mimetype that holds the MIME type for the ZIP container (application/vnd.adobe.air-ucf-package+zip).
2. signatures.xml: A file in the META-INF directory at the root level of the container file system that holds digital signatures of the container and its contents.

 

Verify an existing ZXP package.

Example: ./ZXPSignCmd -verify myExtProject myExtension.zxp

This will show message as 'Signature verified successfully' is the signature is valid.

More information about signing and packaging can be found at Extension Signing-Tech Note.

Extension Folders

Extension Folders

CEP supports 3 types of extension folders.For Bridge, this location is below-

  • Product extension folder. 

    • Win(x86) : C:\Program Files\Adobe\<Bridge Product Folder>\CEP\extensions
      eg. C:\Program Files\Adobe\Adobe Bridge CC 2018 (32 Bit)\CEP\extension

    • Win(x64) : C:\Program Files\Adobe\<Bridge Product Folder>\CEP\extensions
      eg. C:\Program Files\Adobe\Adobe Bridge CC 2018\CEP\extensions

    • Mac:  /Applications/<Bridge Product Folder>/CEP/extensions
      eg.  /Applications/Adobe Bridge CC 2018/CEP/extensions
  • System extension folder

    • Win(x86): C:\Program Files\Common Files\Adobe\CEP\extensions

    • Win(x64): C:\Program Files (x86)\Common Files\Adobe\CEP\extensions, and C:\Program Files\Common Files\Adobe\CEP\extensions (since CEP 6.1)

    • Mac: /Library/Application Support/Adobe/CEP/extensions

  • Per-user extension folder

    • Win: C:\Users\{USER}\AppData\Roaming\Adobe\CEP/extensions

    • Mac: ~/Library/Application Support/Adobe/CEP/extensions


 

Using ExtendScript in a CEP Extension

ExtendScript code for the Host Application can be called from a CEP Extension inside HTML and Java script code in many ways using the EvalScript() function.  ExtendScript code opens up all the Scripting API of the Host Application to CEP Extension developers.The Extend Script code((.JSX) can span across multiple files and there are many ways to load them inside the CEP Extension. A sample using multiple jsx files is also provided.

ExtendScript can be debugged using the ExtendScript  ToolKit CC using below Steps-

  • Open the JSX script in ExtendScript Toolkit CC.
  • Connect it with Bridge(supporting CEP) and put a debug point.
  • Open the CEP Extension and call the EvalScript code. You should be able to debug the ExtendScript code.

Using Nodejs in a CEP Extension

In CEP, Node.js is disabled by default. Below parameter needs to be added in your  CEP Extension Manifest file to enable NodeJS-

Under the resources Tag-add below

<CEFCommandLine><Parameter>--enable-nodejs</Parameter></CEFCommandLine>  

Example-

<Resources>
<MainPath>./index.html</MainPath> 
<CEFCommandLine> 
<Parameter>--enable-nodejs</Parameter>
</CEFCommandLine>
</Resources>

Important Resources

Resource Link Description
Bridge CEP Samples https://github.com/siddharthsingh89/BridgeSamples
CEP 7.0 HTML CookBook https://github.com/Adobe-CEP/CEP-Resources/blob/master/CEP_7.x/CEP_7.0_HTML_Extension_Cookbook.pdf
Application Signing TechNote http://wwwimages.adobe.com/content/dam/Adobe/en/devnet/creativesuite/pdfs/SigningTechNote_CC.pdf
Adobe CEP Resources https://github.com/Adobe-CEP/CEP-Resources
Bridge Scripting Reference http://www.adobe.com/devnet/bridge.html
Adobe ExtendScript Tools Guide https://www.adobe.com/content/dam/Adobe/en/devnet/scripting/pdfs/javascript_tools_guide.pdf

 

About

CEP Extension Samples and documentation for Adobe Bridge CC

Resources

Readme
Activity

Stars

5 stars

Watchers

2 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

No packages published

Languages