Create custom media gallery object types 

Create your own photo and video object types to customize the information provided with each media gallery file. This is optional.


Before starting

To create custom media gallery object types, create XML documents to define them. Then copy those files to the server that Files is installed on, and import them using a command.

Object types are defined in XML according to the Content Management Interoperability Services (CMIS) standard. Detailed documentation for the CMIS standard can be found at the Oasis CMIS web site.

See Sample media gallery object types for samples of photo and video object type definitions you can use as templates for your custom object types. See Work with CMIS API object types for details on creating custom object types.

Things to remember when creating object types:

Note: Users with media galleries must not switch from using an object type for photos, to then using it for videos.


Procedure

To import new object types, perform the following steps.

  1. Start the wsadmin client by completing the following steps:

    1. On the system Files is installed on, open a command prompt, and then change to the following directory:

        app_server_root\profiles\<files_profile_root>\bin
        where <app_server_root> is the WAS installation directory and <files_profile_root> is the Files profile directory.

    2. Enter the following command to start the wsadmin client:

      • AIX or Linux:

          ./wsadmin.sh -lang jython -user <admin_user_id> -password <admin_password> -port <SOAP_CONNECTOR_ADDRESS Port>

      • Microsoft Windows:

          wsadmin -lang jython -user <admin_user_id> -password <admin_password> -port <SOAP_CONNECTOR_ADDRESS Port>

        where:

        • <admin_user_id> is the user name of a person in the Administrator role on the IBM WAS.

        • <admin_password> is the password of the WAS administrator.

        • <SOAP_CONNECTOR_ADDRESS Port> is the SOAP port for the WAS. The default value of the SOAP port is 8879. If you are using the default port value, you do not need to specify this parameter. If you are not using the default and you do not know the port number, you can look up its value in the WAS Integrated Solution Console. To look up the SOAP port number, perform the following steps:

          1. Open the WAS Integrated Solution Console for the deployment manager, and then select System Administration -> dmgr.

          2. In the Additional properties section expand Ports, and then look for the SOAP_CONNECTOR_ADDRESS port entry to find the port number.

        For example:

        • AIX or Linux:

            ./wsadmin.sh -lang jython -username primaryAdmin -password p@assword -port 8879

        • Microsoft Windows:

            wsadmin -lang jython -username primaryAdmin -password p@assword -port 8879

  2. Start the Files Jython script interpreter using the following command:

      execfile("filesAdmin.py")

  3. Run the following command to import the object type definition document:

      FilesObjectTypeService.importType("<path_filename>")

      where <path_filename> is the path and filename of the XML definition document.

  4. Run the following command to check that the new object type was imported. The command returns a list of all object types:

      FilesObjectTypeService.browseTypes()

  5. Restart the Files application.

  6. If your definition adds new properties, add property labels and descriptions to the CMIS language property file. See Add photo and video property labels and descriptions.

  7. Add custom fields to display the new properties. See Including custom fields with photos and videos.

Results

Community owners can select the object type when they add media gallery widgets to their communities. See Add a media gallery to your community.


Parent topic

Configure media galleries


Related tasks


Starting the wsadmin client
Add a media gallery to your community

Related reference
Work with CMIS API object types

+

Search Tips   |   Advanced Search