Posts Tagged ‘CSDT’


We have seen in the previous post about how to Export using CSDT Command Line Tool in Oracle WebCenter Sites / Fatwire.

Today we will see how we can Import using CSDT Command Line Tool in Oracle WebCenter Sites / Fatwire utilizing the exported data which is created earlier.

Before seeing how to use the Import using csdt command line tools, we should know what is meant by import first.

Import:

As the name itself is suggesting, it is the process of creating / importing the assets in(to) the content server. Here, assets means any thing inside the Content Server, right from start menus to templates. Everything. So we can import everything using this process.

Ok..How to use it?

Lets come to the point of how to do the import process using CSDT command line tools.

The syntax of csdt command line is as follows, which is common for both export and import.

java com.fatwire.csdt.client.main.CSDT [ContentServer url]  username= username password= password cmd=export|import|listcs|listds [options]

What are the parameters?

1. SERVER_INFO=http://:ContentServer         —- This is the server into which the assets need to be imported.

2. USER_NAME=fwadmin (or any other user name)

3. PASSWORD=xceladmin (or any other user’s password)

4. CLASSPATH= Path to the  csdt-client-11.1.1.8.0.jar and lib folders present inside the csdt-client folder. For example:

If you have placed your csdt-client folder inside the Content server installation directory, then the class path should be:

/csdt-client/csdt-client-11.1.1.8.0.jar:/csdt-client/lib/*
5. IMPORT_FOLDER_LOCATION=<Content server installation directory>/export/envision/cs_workspace/

This is the location where CSDT files needs to be moved before importing
6. DATA_STORE=/src

Say for example if your folder is CSDT_Backup_Files, then the path should be    /CSDT_Backup_Files/src.

Finally to execute the Import process , make sure that your target content server is running, and run the below command.

In the export process earlier, we have given the 13 digit content server id of the CSElement. But now to import, we need to give the UID created by the content server.

java -classpath $CLASSPATH com.fatwire.csdt.client.main.CSDT $SERVER_INFO username=$USER_NAME password=$PASSWORD resources=CSElement:ca572d73-ade3-4535-bc32-e2311b43fbb8 cmd=import

The above command exports the CSElement  which has the id 1326492057112, to the directory said above called CSDT_Backup_files.

How do I import other resources?

Below are the different resources which can be specified in the import script.

– @SITE – Specify the desired sites
– @ROLE – Specify the desired roles
– @ASSET_TYPE – Specify the desired asset types
– @TREETAB – Specify the desired tree tabs
– @STARTMENU – Specify the desired start menu items
– @ELEMENTCATALOG – Specify the desired ElementCatalog entries
– @SITECATALOG – Specify the desired site catalog entries
– @ALL_NONASSETS – Use this short-hand notation to select all non-asset resources
– @ALL_ASSETS – Use this short-hand notation to select all available assets
– asset type – Specify assets of a certain type.

That’s it.. your content is imported to the target machine.


CSDT Introduction:

CSDT stands for Content Server Developer Tools. This is a great feature provided in Oracle WebCenter Sites that helps the developers to easily import and export assets from one environment to the other environment, such as from DEV to UAT, etc.

This CSDT can be used in two ways.

1. Eclipse – CSDT Plugin:  This is a  plugin which can be embedded and used within eclipse, so that the developers can synch the assets between his workspace and local JSK instance(or any other dev server instance for that matter), and vice-versa.   You can see how to integrate this plugin with eclipse in one of my previous post. Click Here to read the article.

2. Command Line Tool : This is where we use the command line options for exporting and importing the assets between environments. The Developer Tools command-line tool can be used for deployment and other resource movement activities (like assets as said above). Unlike the Eclipse integration, which enables you to work only with the eclipse workspace, the command-line tool enables you to work with any
workspace. The main feature of using the command-line tool is that it provides import and export features which are not available when working in the Eclipse IDE.

How to use the Command-Line Tool:

To use the command line tool, one should use the csdt.zip provided with the Oracle WebCenter Sites installation unit, or with the patches. Make sure that you use the same csdt.zip from the patch which you have applied on your environment (In case if you have applied any patch).

Unzip the csdt.zip file, and you should be able to see two folders inside it.

  • csdt-client
  • csdt-eclipse

The csdt-eclipse folder contains the plugin for integrating with Eclipse.

The csdt-client will have a jar file which is responsible for the command line tools activity, and a lib folder. Under the lib folder you will have some more jar files which are required by the csdt command line tools.  Say for example, if you are using 11.1.1.8 version of Oracle WebCenter Sites, then you should see the following inside the csdt-client folder.

  • csdt-client-11.1.1.8.0.jar
  • lib
    • cas-client-core-3.1.9.jar
    • commons-logging-1.1.1.jar
    • cs-core-11.1.1.8.0.jar
    • rest-api-11.1.1.8.0.jar
    • …. etc

In the upcoming posts, we will see how we can use the CSDT Command line option to export assets like CSElements, Templates, all other assets.

Click on the below links for Export and Import using CSDT Command Line Tools.

1. Import using CSDT Command Line Tool in Oracle WebCenter Sites / Fatwire

2. Export using CSDT Command Line Tool in Oracle WebCenter Sites / Fatwire


First things first. We need the following the components for integrating Oracle WebCenter Sites Devloper Tools with Eclipse:

  1. Latest Eclipse (Can be downloaded from http://www.eclipse.org/downloads/)
  2. CSDT plugin (Developer tools plugin)
Integrating Developer Tools with Eclipse

By following the below steps, we can integrate the Developer tools provided by Oracle WebCenter Sites with Eclipse.

  1. Download and Install WebCenter Sites JDK.
  2. Download the latest version of Eclipse, and install it.
  3. In the WebCenter Sites distribution package, there is a filde called csdt.zip. Unzip it.package. Open the csdt-eclipse folder and save the com.fatwire.csdt.eclipsecsdt_1.0.0.jar file to the plugins folder under your Eclipse installation
  4. Start your local instance of WebCenter Sites (JDK).
  5. Start Eclipse (eclipse.exe) and configure its settings according to your preferences.
  6. In the Eclipse menu bar, select Window > Open Perspective > Other … > Oracle WebCenter Sites.
  7. The configuration screen is displayed. In the configuration screen, fill in the following fields with the information for your WebCenter Sites instance
  8. In the “Sites Installation Directory” field, click Browse to select the directory containing the futuretense.ini file for the WebCenter Sites instance.
  9. In the “Username” field, enter the user name of a general administrator. This user must be a member of the RestAdmin group.
  10. In the “Password” field, enter the password for the user name you entered.
  11. In the “Project name” field, enter a name for the project on which you will be working.
  12. In the “Sites Log File” field, enter the location of your log file (for example, C:/ WCS/logs/sites.log).
  13. The Configuration screen looks as below:Config Screen
  14. Click OK.

 

Configuration is now Complete. Now, the “Oracle WebCenter Sites” perspective opens.  The Oracle WebCenter Sites perspective looks as shown in the below image:

Eclipse IDE

Now you can create and play with templates, elements etc, from eclipse, then sync them with WCS and enjoy coding. Happy Coding 🙂

Related Articles

All the Fatwire / Oracle WebCenter Sites developers are familiar with coding the templates through either Admin interface, or using a text editor such as notepad, etc.  But, Oracle WebCenter Sites provides us with a plugin called DEVELOPER TOOLS (In Fatwire, it was called as CONTENT SERVER DEVELOPER TOOLS plugin), which enables us to work with an Integrated Development Environment like Eclipse. What all we need to do is to use this plugin, and make our work easy by working with Eclipse IDE.

The Developer Tools kit enables developers to work in a distributed environment using tools such as the Eclipse IDE and version control system integration. The developer interacts with Developer Tools (and WebCenter Sites), primarily through Eclipse, which upon integration provides a  set of WebCenter Sites-specific tools for managing assets and other resources.

The Developer Tools kit enables synchronization of resource development in Eclipse with resource development in WebCenter Sites, and resources of WebCenter with resources of Eclipse.

Eclipse Plug-in

 

 

USES OF ECLIPSE IDE Integration

 

There are pretty good usages of integrating the plugin with Eclipse, and coding through Eclipse. Following are the uses through Eclipse integration:

  • Create, edit, and delete Templates, CSElements, and SiteEntries.
  • Develop JSPs with Eclipse features such as tag completion, syntax highlighting, debugging, etc.
  • Export and import assets, asset types, flex families, sites, roles, tree tabs, and start menu items
  • View the output, i.e, Previewing of WebCenter Sites pages within the Eclipse IDE using the preview browser
  • View the WebCenter Sites log file in the error console.