Table of Contents

Search

  1. Preface
  2. Overview, Downloading, and Installing
  3. Administration API
  4. Identity Service API
  5. Screenflow Programming and SDK
  6. ActiveVOS WSHT API
  7. Embedding Request Forms in Standalone Web Pages
  8. XML-JSON for Process Central

7. APIs, SDKs, and Services

7. APIs, SDKs, and Services

Sample Customization Starter Template

Sample Customization Starter Template

The Sample Customization Starter template can be used as a starting point for creating service call steps and custom themes for use in Guide Designer  Simply select
File > New Project > Orchestration Project
, enter a project name, and then select
Guide Designer Customization Starter
to set up the project in your workspace. The following sections describe the contents of this project.
BPEL Processes
The
bpel
folder contains the
HelloWorld.bpel
file that is based on the
HelloWorldAutomatedStep
system service. The service receives a name and returns a Hello World-type of greeting based on the time of day. The process demonstrates the use of a complex-type response and shows a complex type being rendered for display in HTML and uses JavaScript and related technologies for this purpose. You must always create a custom renderer for your custom types.
Deployment artifacts for these BPEL process are in the
deploy
directory.
Guides
This folder contains the definition for the "Hello World" guide. It also contains the system-generated
guide-catalog.xml
file.
A guide is the application that users build in Guide Designer. (Application developers can also create them within Process Developer and Process Designer.) The guide within this folder has a few step types, including a service call step. This step is essentially the
HelloWorld.bpel
process. All of your application's guides will reside in the
guides
folder.
Forms
The folders in the
forms
folder define two of the components that Process Central displays as part of its user interface: the guide explorer and the guide viewer. Use the code in the following folders to see how each was created. You can also use this code if you wish either to create your own explorer or viewer or modify the ones that exist..
  • guide_explorer
    : This folder contains the implementation for the guide explorer within the Forms pane of Process Central. This code, if you like, can be the basis for changing the way the explorer displays.
  • request
    : This folder contains the implementation for the guide viewer. Similar to the way you can use files in the
    guide_explorer
    folder, use this file as the basis for changing the way in which the guide viewer displays.
The
samples-starter.avcconfig.xml
contains information used when configuring form filters.
avcconfig
files here and in other folders control how Process Designer resources are used in a project.
Note
: The Process Server executes your
avcconfig
files in alphabetical order. You can see this order by selecting
Catalog | Resources | Central Configs
from within the Process Console. If one of your files is inadvertently overriding another, you will need to change the file's name to change the execution order.
Reports
The
reports
folder contains the files needed to construct the guides report that displays within Process Central. Use the information in this folder as the basis for creating your own reports. (This report, like other reports used in Process Central, was created using BIRT--Business Intelligence and Reporting Tools.) The
avcconfig
file contains sections that are commented out, and you should uncomment them if you are creating your own versions.
Guide Designer
The
guides
folder contains the resources that the project requires, some of which are deployed in the project deployment contribution and others that you must import directly into Guide Designer. Open the
.xml
files within each of the subfolders to see what was done for this project.
This folder contains four additional folders as well as the
app-config.xml
file.
  • renderings
    : The greeting rendering file defines how output data is displayed. It contains layout details and a script that implements the rendering interface. This file is deployed in the project deployment contribution.
  • resource-contribs
    : If you wish to provide images to guide designers, you must package them into the contribution being deployed along with a screenflowContribution metadata file.
  • service-contribs
    : You must add a
    services.xml
    file to the deployment package for a service call step. This file contains the configuration details that make the service call step type available and to describe how data is used. This file is deployed in the project deployment contribution.
  • theme-contribs
    : When a guide runs, the default background colors, button styles, and other style elements are defined in HTML/CSS format in files deployed to the Process Server and made available to Guide Designer. You can create new themes and use them in a guide. A theme.xml descriptor is deployed as part of the project deployment contribution. This folder also contains other files used by the render.
    Note
    : If you create more than one Guide Designer Customization Starter project, do not deploy
    themes.xml
    more than once. Duplicate deployments create a duplicate theme name conflicts.
The folder also has the
app-config.xml
configuration file. This file has design-time and run-time properties for Guide Designer that declared to be used by the host provider This configuration defines features supported by the host platform as well as possible overrides to Guide Designer.
Note
: There can be no more than one
app-config.xml
file on a server.