Exposing Content through a RESTful API with Web Scripts | Alfresco Developer Guide

Sign In Start Free Trial

Book Overview & Buying
Table Of Contents

Alfresco Developer Guide

4 (7)

Alfresco Developer Guide

4 (7)

Overview of this book

Alfresco Developer Guide

Alfresco Developer Guide

Credits

Credits

About the Author

About the Author

About the Reviewers

About the Reviewers

Preface

Preface

Free Chapter

The Alfresco Platform

The Alfresco Platform

Alfresco in the Real World

Example Used throughout This Book

Alfresco Architecture

Customizing Alfresco

Dusting Off Your Toolbox

Understanding Alfresco's Editions

Summary

Getting Started with Alfresco

Getting Started with Alfresco

Obtaining the SDK

Setting up the SDK in Eclipse

Extending Alfresco

Packaging and Deploying Customizations

Troubleshooting

Starting Over

Summary

Working with Content Models

Working with Content Models

Defining SomeCo's Content Model

Step-by-Step: Relating Types with Associations

Step-by-Step: Adding Aspects to the Content Model

Step-by-Step: Finishing up the Model

Modeling Summary

Modeling Best Practices

Configuring the UI

Working with Content Programmatically

Summary

Handling Content Automatically with Actions, Behaviors, Transformers, and Extractors

Handling Content Automatically with Actions, Behaviors, Transformers, and Extractors

Encapsulating Content Operations in Actions

Binding Logic to Custom Types with Behaviors

Extracting Metadata from Files

Transforming Content from One Format to Another

Summary

Customizing the Web Client User Interface

Customizing the Web Client User Interface

Knowing When to Customize Alfresco's Web Client and When to Write Your Own

Adding New Menu Items with UI Actions

Writing Action Evaluators to Show/Hide UI Actions

Changing How the Web Client Renders Data with Custom Component Renderers

Creating Custom Dialogs

Creating Custom Wizards

Customizing Web Client JSP Pages

Summary

Exposing Content through a RESTful API with Web Scripts

Exposing Content through a RESTful API with Web Scripts

Introducing the Web Script Framework

Planning the SomeCo Whitepapers and Ratings API

Retrieving Data with Web Scripts

Writing Java-Backed Web Scripts

Wiring a Web Script to UI Widgets

Handling Form Data

Customizing the Web Client with Web Scripts

Advanced Web Scripts

Summary

Advanced Workflow

Advanced Workflow

What is a Workflow?

Creating Process Definitions

Using the jBPM Graphical Process Designer

Wiring a Process to the Alfresco UI

Assigning Tasks to Users and Groups

Adding Logic to Workflows with Actions and Process Variables

Using the Workflow API

Using Timers

Debugging Workflows

Comparing Alfresco Workflow Options

Summary

Web Content Management

Web Content Management

Understanding the Difference between Alfresco DM and Alfresco WCM

Obtaining Alfresco WCM

Creating Web Projects

Creating Web Forms

Deploying Content

Performing Post-Deployment Processing

Modifying and Creating WCM Workflows

Working with the AVM API

Using the AVM Console

Summary

Security

Security

Authenticating and Synchronizing with LDAP

Setting Up Single Sign-On (SSO)

Working with Security Services

Summary

API Reference and Examples

API Reference and Examples

Foundation API Public Services

Lucene Queries

JavaScript

API Examples

Alfresco Configuration Reference

Alfresco Configuration Reference

Actions

Web Client Config Elements

Action Groups

Metadata Extractors

Transformers

Graphical View of the Alfresco Content Model

Index

Index

Retrieving Data with Web Scripts

The first service that needs to be implemented retrieves the list of Whitepapers enabled for publication. The web script needs to return the list of Whitepapers in two formats: HTML and JSON. HTML will allow you to easily test the service and JSON will make it easy for code on the frontend to process the list. This will require four files: one descriptor, one JavaScript controller, and two FreeMarker templates—one for each format.

Note

New to JSON? It stands for JavaScript Object Notation. It is a way to describe JavaScript objects in plain text. The beauty of it is that it is extremely easy to create and consume, and it isn't as verbose as XML. For more information on JSON, see http://www.json.org.

Step-by-Step: Writing a Web Script to List Whitepapers

To create a web script that retrieves the list of Whitepapers, do the following:

First, in your Eclipse project create the descriptor file in |config|alfresco|extension|templates|com|someco|whitepapers. Name it...

CONTINUE READING

83

Tech Concepts

36

Programming languages

73

Tech Tools

Unlimited access to the largest independent learning library in tech of over 8,000 expert-authored tech books and videos.

Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.

50+ new titles added per month and exclusive early access to books as they are being written.

Alfresco Developer Guide

Search

Your notes and bookmarks