Documentation for AIA Tool (PIP Auditor, XMAN, Artifact Generator,Template)

Hi
I need complete information how to use all AIA Tools. I need some documentation or tutorial on these.
I visited [AIA Tool|http://www.oracle.com/technology/products/applications/aia/aiatools.html], also metalink 782351.1 . I found how to install the tool, but nt how to run it and analyse the result.
Also reffered AIA Developer guide (2.4). Not found anything.
Can anybody provide any pointer to this?
Thanks In Advance
priyadarshi

In the doc folder inside the dev tools zip file you downloaded from MetaLink is the documentation for how to use the tools.

Similar Messages

Versions Compatible for AIA Comms PIP 11.4

Hi All,
We are installing AIA Comms PIP 11.4 in Solaris SPARC T5-4 machine, we are using below versions for O2C and AABC PIP installation. Can anyone guide us whether all these versions r compatible and what are the patches need to be applied on SOA Suite and AIA?. If anyone know about known issues kindly respond.
Versions -
Oracle Db 11.2.0.3
Oracle Solaris 11.1.11.4.0
SIEBEL 8.1.1.10
OSM 7.2.2.2.0 Patch 16742765 (O2A Catridge - 2.0.1)
WLS - 10.3.6
SOA SUITE - 11.1.1.7
ODI - 11.1.1.7
AIA FP - 11.1.1.7
AIA Comms PIP (AABC, O2C) - 11.4
Also
1) do we need to Install and Configure ODI after SOA or AIA FP.
2) Can we Configure PIP's after installation of end systems basic installation (like configure PIP after basic BRM server installation, siebel server installation, and OSM installation without O2A Catridge )
Thanks a lot in Advance,
RR.

HI ,
as per as my knowledge
1) BRM 7.4 is available
2) BRM 7.3 is suffiecient for Rev Account PIP
3) not sure what all added in 7.4
Regards ,
MOhan

Documentation for Translation Tool in BW (SLWA)

Hi,
i am just trying to translate an infocube using the translation tool in BW (Transaction SLWA).
It is not self-explaining, so i was not able to translate anything. Does anyone has some information/documentation about how to use it ?
Best regards
Simon

Simon,
if you are able to use that tool, let me know!
I never gain anything from it...
Anyway, there is some OSS note you can use to better understand the procedure...
496192 'Translating and transporting BW objects'
696543 'AWB translation connection - new translation tools'...
Let me know your mail...
Hope it helps!
Bye,
Roberto

AIA PIP Auditor Error.

Hi All
I get the following error while using PIP auditor using the command
pipaudit -InputDir d:\Core -OutputDir d:\op
InputDir is a mandatory argument
Exception in thread "main" java.lang.IllegalArgumentException: Please specify in
put source directory.
at oracle.apps.aia.pipaudit.PIPAuditor.setHashMap(PIPAuditor.java:165)
at oracle.apps.aia.pipaudit.PIPAuditor.audit(PIPAuditor.java:268)
at oracle.apps.aia.pipaudit.PIPAuditor.run(PIPAuditor.java:699)
at oracle.apps.aia.pipaudit.PIPAuditor.main(PIPAuditor.java:642)
The pipaudit -version returns the following output.
AIA Developer Tools Build :: DeveloperTools:M6_S2 Build date :: Dec 17 2009 11:5
7:36AM GMT
Copyright ⌐ 2009 Oracle. All Right Reserved.
While java -version returns
java version "1.5.0_06"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_06-b05)
Java HotSpot(TM) Client VM (build 1.5.0_06-b05, mixed mode)
Is there anything else which i need to do in order to run the Pip auditor.
Regards
Abhradeep

Hi Neeraj,
Thanks for your quick response. But bad part I couldnt resolve this issue.
I ve used the same init Small case. I have followed the same docs. Still I m getting the error. I have
PIPAuditor.jar
xalan.jar
xercesImpl.jar
xmlparserv2.jar
xmlunit-1.2.jar these jars inside my DeveloperTools/lib folder
And I have ran the PIP Auditor script frm PIPAuditor/bin
with the following command
pipaudit –inputDir E:\Sanjay\Application2\ –outputDir E:\Sanjay\output
where E:\Sanjay\Application2\ has my custom PIP.
And I get this error
on/esb/lib/commons-codec-1.3.jar;E:/Oracle/10.1.3.1/SOA/j2ee/home/admin_client.j
ar;E:/AIAHOME/lib/InstallUtils.jar
-outputDir :outputFolder :E:\Sanjay\output
InputDir is a mandatory argument
Exception in thread "main" java.lang.IllegalArgumentException: Please specify in
put source directory.
at oracle.apps.aia.pipaudit.tools.PIPAuditor.setHashMap(PIPAuditor.java:
159)
Can you please suggest a solution
Thanks
Sanjay

AIA documentation for operations

I am looking fror documentation to operate and monitor AIA.
- How to monitor ESB/BPEL processes
- Error handling
- Stop/start server
- Retry failed processes
- Analyze errors
This information is probably scattered in BPEL PM, Enterprise Manager, ESB and AIA documentation.
Is there also an overview document referencing the detailed manuals?
We're using AIA 2.0.1 on 10.1.3.3
Thanks,
Jan Willem

In the doc folder inside the dev tools zip file you downloaded from MetaLink is the documentation for how to use the tools.

Tools to write documentation for the lazy guy?

Hi all, from some years i'm developing a graphical project, but i've never had the will to write the documentation.
...what a boring task.
But now that i think my project is quite complete and stable, the time has come.
What tools do you suggest? There are a lot of functions,menues,checkboxes and so on to write about, so the natural end would be an hypertext with images.
Any advice for the task?
Thanks!

It depends. What kind of application did you make and which what toolkit and what kind of documentation would you like to provide?
I wrote an application using wxWidgets, which includes a "Help Window" widget that just displays an HTML string. That made it super easy to provide graphical in-application help.
I wrote a couple of man pages (like for packer). I think those are kind of fun to make. I simply did an Internet search for "how to make a man page" or something. It was pretty easy to learn.
kokoko3k wrote:from some years i'm developing a graphical project, but i've never had the will to write the documentation. ...what a boring task.
Some people find programming boring and writing documentation to be an enjoyable contribution. If you release your program and people like it someone might write the documentation for you.

Documentation for category "My LiveCycle Tools", createDomDocument

Using LiveCycle Workbench ES2, v 9.0.0.1.20100511.1.236086
Disclaimer - I'm a novice in Workbench, and with adobe development tools, so please be patient if I am asking naive questions or going about things in a goofy way, or neglecting to include salient details.
We are attempting to use the "createDomDocument" service operation provided by service "myLiveCycleTools". I have been unable to find any documentation for this category or service. Does it exist?
We are using the DOM Document that this service operation creates to store data extracted from a barcode. In the event the barcode is not found, we would prefer to not generate an XML file with empty tags. We were told by an adobe rep that if the "Document" variable is NULL that the file won't be written. I can ensure that all of the internal tags are null, but not the root element which is specified as part of the configuration of the process properties in Workbench. I was hoping the documentation would tell me how to null out the root element as well. Other approaches to solve the problem of creating unnecessary empty files are welcome.
Thanks!

I took a look at a couple of our installations for LC ES2 Update 1 (also known as 9.0.0.1) and I don't see a createDomDocument or a myLiveCycleTools service. It looks like it may be a custom component/service. Is there a possibility that someone in house or a contractor developed this for you?
If you use the BarcodedFormsService operation "Extract to XML" then you can get the data into an XML format. Then using a setValue operation with the Node Set count function should tell you how many nodes there are in your XML. That should allow you to make decisions as to if the XML object is empty or not.

Documentation for Package BCA_RELEASE (Release Tools)

Hi ABAPers,
does anybody know if there is somewhere documentation for package BCA_RELEASE? It's the release tool for the SAP workflow. I couldn't find anything so far.
Thanks in advance and regards,
Martin

Post Author: munrobasher
CA Forum: General
Ahh ignore me - I see it's unpacked as part of the mammoth 1GB+ download of release 2.
Thanks, Rob.

Documentation for AIAArtifactGenerator

Hi
I havent worked on AIA so please excuse me if am asking basic questions. I downloaded the AIA Developer Tools provided by Oracle from metalink (Metalink Note 782351.1). I was able to run PIPAuditor, XSDFlattner on a few samples. I need to run AIAArtifactGenerator and have some basic questions on it.
1. how does it work? I believe it is used to generate a requester and provided abcs but how do i go about executing it?
2. what is provided as input?
3. what is the command to run it?
I was unable to find information on AIAArtifactGenerator in the docs folder under DeveloperTools. If someone could please help me with the above questions or the documentation it would be great.
Thanks!

Artifact Generator gives a jump start for the AIA developers to construct ABCS. AIA Artifact generator will generate code adhering to the AIA programming models and AIA naming conventions. You can generate Requestor and Provider ABCS using this tool.
1. how does it work? I believe it is used to generate a requester and provided abcs but how do i go about executing it?
Yes you are correct. This will generate BPEL, WSDL interfaces, Error Handling Framework, CAVS enablement and extension points. To make ABCS executable, you need to perform below things...
a. Complete business payload transformation
b. Rearrange service invocations if necessary (sequence/conditions)
c. Configure Correlation for Asynchronous Application service invocation
d. Create invocations for other operations when service is called multiple times
e. Altering
i. Deploy Descriptor Properties in bpel.xml
ii. Policies in fault policy
iii. properties in Configuration properties file
2. what is provided as input?
input is input.xml file, best way of designing your input xml file is to take a sample file shipped with tool and modify to your needs.
3. what is the command to run it?
ant buildBPEL
Hope this information helps.
Thanks,
Chapter 4: Designing and Constructing ABC Services, "Working with the Artifacts Generator"

Documentation for ant task wscompile ??

Is there any documentation for the ant task wscompile? In the HelloWorld example, the task is mapped to this class:
com.sun.xml.rpc.tools.ant.Wscompile

I do not know if any documentation exists but I have generated some for my own use. You are welcome to it and please let me know of any inaccuracies :)
Attribute : Description => Required
classpath : Specify where to find input class files. => Yes.
base : Specify where to place generated output files. => No; defaults to present directory.
define : Defines a service using the Java classes. => No, but exactly one of the import, define, or client attributes must be specified.
features : Enable the given features. => No; Features should be specified seperated by a space character.
debug : Generate debugging info. => No; defaults to false.
both : Generate both client and server artifacts (ties, etc.) => No; defaults to false.
client : Generate client artifacts (stubs, etc.). => No, but exactly one of the import, define, or client attributes must be specified.
server : Generate server artifacts (ties, etc.). => No; defaults to false.
source : Generate code for the specified JAXRPC SI version. Supported values are: 1.0.1, 1.0.3 and 1.1 => No; defaults to 1.1
proxyServer : URL of the proxy server including hostname and port. => No; defaults to localhost:8080.
import : Generate interfaces and value types only. => No, but exactly one of the import, define, or client attributes must be specified.
keep : Keep generated files. => No; defaults to true.
mapping : Write the 109 mapping file to the given file. => No.
model : Write the internal model to the given file. => Yes.
nonClassDir : Specify where to place non-class generated files. => No; defaults to present directory.
optimize : Optimize generated code => No; defaults to false.
config : Configuration file for generating webservice. => Yes.
sourceBase : Directory for storing the generated source files. => No; defaults to present directory.
verbose : Output messages about what the compiler is doing. => No; defaults to false.
version : Prints version information. => No; defaults to false.
xPrintStackTrace : Prints stack trace of the errors. => No; defaults to false.
xSerializable : Generate value types that implement Serializable interface. => No; defaults to false.
xDebugModel : Write readable version of the model to a file. => No.

Documentation for wscompile?

I finally got around to updating to jwsdp-1_0_01 and was surprised to find that xrpcc was replaced by wscompile in many build.xml files. Except for a few very general remarks in the Tutorial, I can't find any documentation for wscompile at all (Google returns only 4 pages for "wscompile"!).
Is xrpcc deprecated? (When my old build.xml runs xrpcc, it gives a warning that "sun.tools.javac.Main is deprecated".) Is there a man page, etc., for wscompile?
Thanks,
Mike

Oops, the format of my last message got munged. Here's anoter try:
Date: 28 Aug 2002
Title: The JAX-RPC wscompile and wsdeploy Tools
1 The wscompile Tool
The wscompile tool generates stubs, ties, serializers,
and WSDL files used in JAX-RPC clients and services.
The tool reads as input a configuration file and either
a WSDL file or an RMI interface that defines the service.
1.1 Syntax
wscompile [options] <configuration-file>
By convention, the configuration file is named config.xml,
but this is not a requirement.
The following table lists the wscompile options.
Note that exactly one of the -import, -define,
or -gen options must be specified.
Option                    Description
-classpath <path>         specify where to find input class files
-cp <path>                same as -classpath <path>
-d <directory>            specify where to place generated output files
-define                   read the service's RMI interface,
                            define a service
-f:<features>             enable the given features (See the below
                            table for a list of features. When
                            specifying multiple features, separate
                            them with commas.)
-features:<features>      same as -f:<features>
-g                        generate debugging info
-gen                      same as -gen:client
-gen:client               generate client artifacts (stubs, etc.)
-gen:server               generate server artifacts (ties, etc.) and
                            the WSDL file (If you are using wsdeploy
                            you do not specify this option.)
-gen:both                 generate both client and server artifacts
-httpproxy:<host>:<port> specify a HTTP proxy server (port defaults to 8080)
-import                   read a WSDL file, generate the service's RMI
                            interface and a template of the class that
                            implements the interface
-keep                     keep generated files
-model <file>             write the internal model to the given file
-nd <directory>           specify where to place non-class generated files
-O                        optimize generated code
-s <directory>            specify where to place generated source files
-verbose                  output messages about what the compiler is doing
-version                  print version information
The following table lists the features (delimited by commas) that
may follow the -f option.
Feature                   Description
datahandleronly           always map attachments to the DataHandler type
explicitcontext           turn on explicit service context mapping
infix=<name>              specify an infix to use for generated serializers
nodatabinding             turn off data binding for literal encoding
noencodedtypes            turn off encoding type information
nomultirefs               turn off support for multiple references
novalidation              turn off full validation of imported WSDL documents
searchschema              search schema aggressively for subtypes
serializeinterfaces       turn on direct serialization of interface types
1.2 Configuration File
The wscompile tool reads the configuration file (config.xml),
which contains information that describes the web service.
The basic structure of config.xml follows:
<?xml version="1.0" encoding="UTF-8"?>
<configuration
    xmlns="http://java.sun.com/xml/ns/jax-rpc/ri/config">
   <service> or <wsdl> or <modelfile>
</configuration>
The <configuration> element may contain exactly one
<service>, <wsdl>, or <modelfile> element.
1.2.1 The <service> Element
If you specify this element, wscompile reads the
RMI interface that describes the service and
generates a WSDL file.
In the <interface> subelement, the name attribute specifies the
service's RMI interface, and
the servantName attribute specifies the class that implements
the interface.
For example:
<service name="CollectionIF_Service"
         targetNamespace="http://echoservice.org/wsdl"
         typeNamespace="http://echoservice.org/types"
         packageName="stub_tie_generator_test">
     <interface name="stub_tie_generator_test.CollectionIF"
      servantName="stub_tie_generator_test.CollectionImpl"/>
</service>
1.2.2 The <wsdl> Element
If you specify this element, wscompile
reads the service's WSDL file and generates
the service's RMI interface.
The location attribute specifies the URL of the WSDL
file, and the packageName attribute specifies
the package of the classes generated by wscompile.
For example:
<wsdl
    location="http://tempuri.org/sample.wsdl"
    packageName="org.tempuri.sample" />
1.2.3 The <modelfile> Element
This element is for advanced users.
If config.xml contains a <service> or <wsdl> element,
wscompile generates a model file that
contains the internal data structures that describe
the service.
If you've already generated a model file in
this manner, then you can reuse it the
next time you run wscompile. For example:
<modelfile location="mymodel.xml.gz"/>
2.0 The wsdeploy Tool
The wsdeploy tool reads a WAR file and the jaxrpc-ri.xml
file and then generates another WAR file that is ready for
deployment.
Behind the scenes, wsdeploy runs wscompile with the -gen:server option.
The wscompile command generates classes and a
WSDL file which wsdeploy includes
in the generated WAR file.
2.1 Syntax
The syntax for wsdeploy follows:
wsdeploy <options> <input-war-file>
The following table lists the tool's options.
Note that the -o option is required.
Option                    Description
-classpath <path>         specify an optional classpath
-keep                     keep temporary files
-o <output-war-file>      specify where to place the generated war file
-tmpdir <directory>       specify the temporary directory to use
-verbose                  output messages about what the compiler is doing
-version                  print version information
2.2 The Input WAR File
Typically, you create the input WAR file with a
development tool or with the ant war task.
Here are the contents of a simple input WAR file:
META-INF/MANIFEST.MF
WEB-INF/classes/hello/HelloIF.class
WEB-INF/classes/hello/HelloImpl.class
WEB-INF/jaxrpc-ri.xml
WEB-INF/web.xml
In this example, HelloIF is the service's RMI interface
and HelloImpl is the class that implements the interface.
The web.xml file is the deployment descriptor of a
web component. The jaxrpc-ri.xml file is described
in the next section.
2.2.2 The jaxrpc-ri.xml File
The listing that follows shows a jaxrpc-ri.xml file
for a simple HelloWorld service.
<?xml version="1.0" encoding="UTF-8"?>
<webServices
    xmlns="http://java.sun.com/xml/ns/jax-rpc/ri/dd"
    version="1.0"
    targetNamespaceBase="http://com.test/wsdl"
    typeNamespaceBase="http://com.test/types"
    urlPatternBase="/ws">
    <endpoint
        name="MyHello"
        displayName="HelloWorld Service"
        description="A simple web service"
        interface="hello.HelloIF"
        implementation="hello.HelloImpl"/>
    <endpointMapping
        endpointName="MyHello"
        urlPattern="/hello"/>
</webServices>
The <webServices> element must contain one or more <endpoint>
elements. In this example, note that the interface and
implementation attributes of <endpoint> specify the
service's interface and implementation class.
The <endpointMapping> element associates the service
port with an element of the endpoint URL path
that follows the urlPatternBase.
3 Advanced Topics
This section is for developers who are familiar with
WSDL, SOAP, and the JAX-RPC specifications.
3.1 Namespace Mappings
Here is a schema type name example:
schemaType="ns1:SampleType"
xmlns:ns1="http://echoservice.org/types"
When generating a Java type from a schema type,
wscompile gets the class name from the local part of
the schema type name.
To specify the package name of the generated
Java classes, you define a mapping between
the schema type namespace and the package name.
You define this mapping by adding a <namespaceMappingRegistry>
element to the config.xml file. For example:
<service>
    <namespaceMappingRegistry>
            <namespaceMapping
            namespace="http://echoservice.org/types"
            packageName="echoservice.org.types"/>
     </namespaceMappingRegistry>
</service>
3.5 Handlers
A handler accesses a
SOAP message that represents
an RPC request or response.
A handler class must implement
the javax.xml.rpc.handler interface.
Because it accesses a SOAP message,
a handler can manipulate the message with
the APIs of the javax.xml.soap package.
Examples of handler tasks:
* Encryption and decryption
* Logging and auditing
* Caching
* Application-specific SOAP header processing
A handler chain is a list of handlers.
You may specify one handler chain for the client
and one for the server.
On the client, you include the <handlerChains> element
in the jaxrpc-ri.xml file. On the server, you
include this element in the config.xml file.
Here is an example of the <handlerChains> element
in config.xml:
<handlerChains>
<chain runAt="server"
     roles=
      "http://acme.org/auditing
       http://acme.org/morphing"
       xmlns:ns1="http://foo/foo-1">
    <handler className="acme.MyHandler"
      headers ="ns1:foo ns1:bar"/>
      <property
        name="property" value="xyz"/>
    </handler>
</chain>
</handlerChains>
For more information on handlers, see the SOAP Message Handlers chapter
of the JAX-RPC specifications.

How to create documentation for report programs and how to use it

how to create documentation for report programs and how to use it in the selection screen by placing an icon in the Applicatin Tool bar. If i click this icon the help documentation has to display.
Note: Exaple <b>RSTXSCRP</b> programs selection screen

Hi
1 goto SE38 transaction, give the program name
2 Click on documentation radiobutton & then press change
3 Write your PURPOSE, PREREQUISITES etc details
4 Save the same & Activae it.
The icon will come automatically on selection screen
Thanks
Sandeep
Reward if useful

Documentation for PostProcessingPluginHelper

Does documentation for the PostProcessingPluginHelper class exist? I have not been able to find it in the Java SDK docs. I'm trying to determine the arguments to the PostProcessingPluginHelper.createInfoObject(...) method. My objective is to add a dynamically generated Word document to the artifacts to be delivered by the publication.
Thanks!
-m

The question about the documentation still stands, but as far as adding word documents, there is a comparable example in the developer guide.
At the bottom of the "handle" method in the post processing plugin, use the following code to add a word doc:
File addedFile = new File(tmpDir + "\\MyFile.doc");
IWord addedFileInfoObject =
(IWord)PostProcessingPluginHelper.createInfoObject(context, CeProgID.WORD, "application/msword", null, null);
addedFileInfoObject.getFiles().addFile(addedFile);
// return the list of info object artifacts that should be delivered by the publication
IInfoObjects newInfoObjects = context.getInfoStore().newInfoObjectCollection();
newInfoObjects.add(addedFileInfoObject);
return newInfoObjects;

Technical documentation for ADF projects - how to and best practices

Hi,
I have a question how to create technical documentation for ADF project expecialy ADF BC and ADF Faces. Is there any tool or JDev plugin for that purpose? What informations should contains documentation for that project, any principles ?Has anybody any experienece. Are there something like documentation best practices for ADF projects? E.g. how to create documentation for bussiness components.
Kuba

I'm not sure there is "best practices" but some of the things that can help people understand are:
An ADF BC diagram - this will describe all your ADF BC objects - just drag your components into a new empty diagram
A JSF page flow - to show how pages are called.
Java class diagram - for Java code that is not in the above two
One more thing to consider - since ADF BC, JSF page flow and JSPX pages are all XML based - you could write XSL files that will actually transform them into any type of documentation you want.

Hi all ,i need a good documentation for a beginner in WORK FLOW ?

hi all ,
i need a good documentation for a beginner in WORK FLOW ?
please,try to send the attached documents as much as u can apart from giving the weblinks ?
hope you will send it soon ....
thanks & regards
vishnuvardhan k.v.

Hi
Developing a simple application using steps "User Decision" and "Mail"
Basic terminology used in the workflow:
The workflow definition is the set of rules that determine the path that the process takes. For example, how a purchase requisition is processed, from the initial request to the creation of the purchase order
A Workflow Instance, which is often simply referred to as the workflow, is a single workflow run. For example, the processing of a single purchase requisition for computers.
The Tasks are the steps in the process, which have to be performed either by people or automatically by the software. For example, to check for the availability of the spare computers in the company.
A Work item is the task instance that is performed as a single workflow step. For example, check that there are no spare computers available in the company.
Agents are the people who process the tasks (via the work items). For example, requisitioner and a member of the purchasing department.
Container is the place where all the data used in the workflow is collected.
Binding is the set of rules that define which data is passed to which part of the process.
Building a simple workflow application
The central tool for creating, displaying and processing a workflow is the workflow builder (Transaction SWDD). Within the workflow builder you can create all components of a workflow, including all the containers you need for getting the data from one step to another.
Generally, most of the workflows are started by an event (for example, when a material is created or when a new purchase requisition arrives). You define which data from this event needs to be passed to the workflow via binding.
However you can also start any workflow directly. Let us create a simple workflow and start the workflow directly, using the testing tools.
Call transaction SWDD. When the workflow builder is called for the first time, a newly created initial workflow definition appears or else last created workflow appears. In such cases you can opt to create a new workflow by pressing Create New Workflow(ctrl + shft + F5). The following screen appears.
The initial workflow screen has the following parts:
a. The start of the workflow definition, indicated by .
b. The end of the workflow definition, indicated by .
c. The area in which you insert the new workflow definition is indicated by .
Now select the undefined step and select Create step or double click the undefined step. Now among the different steps chose the User Decision by double clicking on it.
Developing a simple application using steps "User Decision" and "Mail"
Previous
Now enter the title for the user decision Please make a decision. Also enter the decision texts as Approve and Reject. On pressing enter, the outcome values default to the Decision texts but you can specify your own names, if desired. Now we need to select the agent. Agent is the person to whom the work item needs to be sent.. Since this is just a beginning, we would hardcode the user name. Select the User from the drop down list and enter the user name to whom the work item needs to be sent. In general, this type of agent assignment is not done. Agents are generally assigned using the expression, agent assignment rule or organization object (job, position etc.).
Now select Transfer and to graphic button. Following screen appears:
Now we need to include a mail step to be sent to the requestor. Now select the line Approve and do a right click. Different options on shown on the context menu. Select Create.
Now select the step Send Mail from the list.
Developing a simple application using steps "User Decision" and "Mail"
...Previous
Now enter the subject and the body of the message for the mail to be sent.
Do not change the recipients. Our mail is intended for the persons who triggered this workflow. &_WF_INITIATOR& contains the value who executed the workflow. Since this is a test object, we are using &_WF_INITIATOR&. But we wouldnt be using this variable in real time scenarios. We would discuss about this in the coming documents.
Now select Transfer and to graphic button.
A popup appears requesting for the abbreviation and the name for this task. Enter the same and press enter.
Now enter the package as local object and press enter.
Follow the steps 5 through 9 for the step Reject. The following screen appears:
Press SAVE to save the workflow application. You need to enter an abbreviation and name for your workflow as shown below. You can change any of these at any later point. After saving, a number is assigned to your workflow starting with WS, as shown below.
Developing a simple application using steps "User Decision" and "Mail"
...Previous
To execute the workflow, activate it by choosing the activate button.
Test the workflow by choosing Test. The following screen appears.
Now choose Execute to start the workflow.
Now the recipient would receive a work item in his SAP® inbox (Transaction SBWP).
Now execute the work item by pressing Execute. The following screen appears:
Choose one among Approve or Reject as part of the user decision. He can select the third option to retain the work item in his inbox and make the decision later. Now suppose that the recipient has chosen one of the first options. Now a mail would be sent to the requestor with the status of his request.
Creating a Container element
This document details about creation of a container element in workflow and using it in the step "Mail".
Pre-requisites:
It is assumed that the reader of this Tutorial is aware of creating a workflow definition with the step Mail. If not, please go through the document on creating the same available, by clicking here.
Steps:
1. Create a workflow definition using the transaction SWDD.
2. Lets create a container element for Carrier id. Click on the Workflow Container on the left side of the screen (as shown in the screenshot below):
3. Now double-click on Double-Click to Create
4. Enter the details pertaining to CARRID here.
5. Click on tab Properties and select Import.
6. Click on Confirm (Enter).
7. Now the element created could be seen on the left side, below the Workflow Container.
Creating a Container element
Previous
1. Create a Mail step by double-clicking on Undefined step in the workflow.
2. Enter the recipient details in the Recipients box.
3. In the subject line, enter Carrid value entered is: and click on Insert Expression.
4. Select the element Carrid from the list.
5. Similarly enter the content in the Body area.
6. Save and activate the application.
Testing the Workflow application:
7. Test the workflow by clicking F8.
8. Enter the value of the Carrid as shown above and press execute.
9. A mail would be sent to the recipient mentioned earlier with the carrid value entered.
Condition Step
Agenda:
This document details about the steps Condition.
Pre-requisites: It is assumed that the reader of this document has a preliminary understanding of workflow and has worked with the container elements earlier. If not, please go through the first two Tutorials of workflow available in this site. (More details)
Procedure:
1. Create a new workflow definition.
2. Create a container element, CARRID (as demonstrated in tutorial 2).
3. Now click on undefined step and create the step Condition.
4. Enter the step name of your choice.
5. We would have the following condition here:
If carrid = AA.
Do this.
Else.
Do this.
Click on Click here to create a new condition. Following screen appears.
Double click on Carrid. Next click on = and enter the value AA in the constant field and press ENTER.
Enter the outcome names of your choice as shown above.
Click on Transfer and go to graphic.
As shown above, there are two branches here. One navigates to true, if CARRID = AA else the control takes the branch False.
Test the above scenario by inserting mail steps in the above 2 branches and by passing different CARRID values.
Condition Step
Agenda:
This document details about the steps Multiple Condition.
Pre-requisites: It is assumed that the reader of this document has a preliminary understanding of workflow and has worked with the container elements earlier. If not, please go through the first two Tutorials of workflow available in this site. (More details)
Procedure:
1. Create a new workflow definition.
2. Create a container element, CARRID (as demonstrated in tutorial 2).
3. Now click on undefined step and create the step Multiple Condition.
4. Enter the step name of your choice.
5. We would have the following condition here:
If carrid = AA.
Do this.
Elseif carrid = AH
DO this.
Elseif carrid = SQ
Do this.
Else.
Do this.
Select the CARRID using the F4 help for the comparison basis field.
Enter the values of the carrid under the Comparison values with the corresponding outcome name (of your choice)
Double click on Carrid. Next click on = and enter the value AA in the constant field and press ENTER.
Click on Transfer and go to graphic.
As observed above, there are different branches for each value of CARRID mentioned above.
Test the above scenario by inserting mail steps in all the branches and by passing different CARRID values.
Using "Container Operation" step
Agenda: Usage of step Container Operation.
Pre-requisites: It is assumed that the reader of this tutorial has worked in the concepts that are dealt in earlier tutorials. (click here for more details)
Scenario: In this tutorial, we would deal about how to work with the step Container Operation with an example of calculating the available seats by subtracting occupied seats from the maximum seats at the workflow level.
Procedure:
1. Create a new workflow definition using the transaction SWDD.
2. Create two container elements MaxSeats, Occ_Seats with the import property set. You can use the reference fields sflight-seatsmax, sflight-seatsocc for this.
3. Create another container element AvailableSeats without setting either import or export property as this is calculated within the workflow and used within the workflow. You might use any of the above reference fields as data types.
4. Define a new step Container Operation in the workflow definition by double-clicking on the Undefined step.
5. In this step, we would calculate the available seats from the max seats and seats occupied.
I would recommend entering all the container elements from the F4 help instead of typing them manually.
6. Return to the main screen.
7. Create a mail step after this to send the available seats information.
8. Test the above functionality by passing some values to the maximum and the seats occupied.
9. Result would be as follows:
Triggering Events Programmatically
Purpose: This document details the procedure in triggering the business object events programmatically.
Pre-requisites: It is assumed that the reader of this document is aware of the business object concepts and good in ABAP.
Procedure:
In this document, we would take an example of the business object BUS1001006 (Material) and the event CREATED. In general, this event is triggered whenever a material is created using a standard procedure like MM01 or any others. Now we would trigger this event from our own programs.
Following are the screenshots of the business object BUS1001006 and the event CREATED. Go to transaction SWO1 for more information of the business object.
Double-clicking on the key field parameter gives you technical information of the field.
In order to trigger an event programmatically, we would use the function module SWE_EVENT_CREATE.
Following is the sample code to trigger the events programmatically:
REPORT ZDEMO_TRIGGER_EVENT.
DATA: KEY LIKE SWEINSTCOU-OBJKEY.
KEY = '1163'. Material Number (hard-coded)
CALL FUNCTION 'SWE_EVENT_CREATE'
EXPORTING
objtype = 'BUS1001006'
objkey = KEY
event = 'CREATED'
CREATOR = ' '
TAKE_WORKITEM_REQUESTER = ' '
START_WITH_DELAY = ' '
START_RECFB_SYNCHRON = ' '
NO_COMMIT_FOR_QUEUE = ' '
DEBUG_FLAG = ' '
NO_LOGGING = ' '
IDENT =
IMPORTING
EVENT_ID =
TABLES
EVENT_CONTAINER =
EXCEPTIONS
OBJTYPE_NOT_FOUND = 1
OTHERS = 2
IF sy-subrc <> 0.
MESSAGE ID SY-MSGID TYPE SY-MSGTY NUMBER SY-MSGNO
WITH SY-MSGV1 SY-MSGV2 SY-MSGV3 SY-MSGV4.
ELSE.
WRITE 'Event Triggered'.
ENDIF.
COMMIT WORK.
In order to test whether the event is getting triggered or not, we can make use of Event Trace. Switch on the event trace using the transaction SWELS.
Press Switch On.
Now execute the program developed earlier. Now switch-off the event trace using the same transaction SWELS.
Now go to transaction SWEL. Here you can list out the events triggered in the particular period of time. Here is the event-trace list:
Deadline Monitoring in SAP Workflow
A major advantage of workflow is the ability to monitor the workflow steps according to a predefined schedule. Following are different deadlines that can be monitored against each workflow step:
Requested Start
Latest Start
Requested End
Latest End
In this example, we will define a deadline to the User Decision example created earlier (click here). Following is the screenshot of the application developed using the User Decision example:
We would extend this example to the deadline monitoring.
In the User Decision step, click on the latest end tab.
By default, No deadline monitoring is active (as seen in the above screenshot).
Choose the Work Item Creation from the list box.
After selecting Work Item Creation, chose an offset of 5 minutes. This means that the work item must be executed within 5 minutes of the creation, if not this would trigger.
Deadline Monitoring in SAP Workflow
Enter recipient details to whom the message to be escalated, if the work item is not executed with in 5 minutes after work item creation.
Save and activate the workflow definition.
Testing the workflow application:
Execute your workflow.
Check for the work item in the SAP Inbox. This time do NOT execute the work item.
Wait for the deadline to be triggered. After that, a deadline message is delivered to the recipient mentioned in the Latest End tab. See the screenshot below.
Dont worry if the deadline message doesnt appear immediately after 5 minutes. This depends on various factors including how the deadline monitoring program is scheduled and also on the availability of the background processors.
Use SWWA to check how the deadline monitoring program is scheduled in program.
For example, assume that our work item has been created at 09:10 hrs and the deadline message is expected to trigger at 09:15 hrs. From the above screenshot, it is understood that the background program is scheduled to execute for every 3 minutes. Assume that the last run of the program is at 09:14hrs and the next run is expected at 09:17hrs. So even our deadline expires at 09:15, the deadline message would appear only at 09:17hrs after execution of the background program.
Some more points
In our above example, we have used the deadline on the Work Item creation time. i.e., 5 minutes after creation time, the deadline message would be sent. Now we would check the other option Expression. Here we can mention the date and time, when the deadline message should appear irrespective of the work item creation date/time.
As seen in the above screenshot, we can provide the target date and time by which the task should be finished. Container elements could be used in this case. Please refer to our example on creation of container elements (click here).
Personal Substitute in Workflow
Requirement: Need to have at least one substitute who can act upon work items in your absence.
Important: The appointed substitute would be able to see all your work items. A substitute cannot be assigned for only particular area of organization or any other item. So need to ensure that the substitute have the necessary authorizations to act upon the work items.
Procedure:
1. Go to SAP Business Work Place (TCode: SBWP)
2. Now from the menu bar, select Settings à Workflow settings à Maintain Substitute
3. Highlight/Select the name on the window, in this case SAPDEV02 and click on Create Substitute.
4. List of users available in the system are displayed.
5. Select the required substitute user name. Following screen appears.
Validity field describes about the period in which the setting would be active. Note that the dates on the screen would range from the current date to 31st Dec 9999.
Regarding the checkbox Substitution active, it is advised to leave this checkbox unchecked for system performance reasons. A check in this box indicates that the substitution is permanent and if left unchecked it is treated as as-needed. A permanent substitute will automatically receive the primary users work items in their own box. In the case of as-needed, substitute must manually adopt the work items from the primary users inbox.
6. Save the entries
7. Click Enter to leave the screen.
Adopting a Substitute in Workflow
If you have been designated as an as-needed substitute, you must manually adopt the substitution. If you are designated as a permanent substitute, the work items would automatically appear in the inbox.
Before adopting a substitution, there are 19 work items in the inbox. See the screenshot below:
To adopt a substitution, select Settings à Workflow settings à adopt substitution.
Select the corresponding User-id (if you have been assigned as a substitute for multiple people, then this option would allow you to select the user name of whom you would to check the work items)
The corresponding users work items would appear in our inbox now.
You can end the substitution, by selecting settings à Workflow settings à End substitution.
Note: Substitutes can only adopt work items that are directly routed to the person for whom they are a substitute. If you are a substitute for a user (SAPDEV02) who has been made a substitute for another user (SAPDEV01), you will only see work items for user SAPDEV02 and not of the user SAPDEV01.
Notification of Work Items via e-Mail
SAP provides us with a facility of notifying the user via the email address of your choice when there are any pending work items in the SAP Inbox..
1. Go to Transaction SO13.
2. Click on Automatic Forwarding tab.
3. Click on Create icon .
4. Enter the details in the above screen.
5. Click ENTER to complete the entries.
6. Now the notification would be received at the provided email address if there are any pending work items in the inbox.
Filtering the Work Items in the SAP Inbox using BADI
This document details about the procedure in filtering some of the work items from the SAP inbox using a BADi.
Following is the screenshot of the SAP inbox, before implementing BADi:
The BADi that is used in filtering the work items is WF_BWP_SELECT_FILTER. To implement the BADi, go to transaction SE18. From the menu, select Implementation à Create. (See the screenshot below)
Enter the implementation name and press ENTER
Enter any meaningful short text for the implementation and click on the tab Interface
The implementing class, ZCL_IM_BWP_SELECT_FILTER, is automatically proposed. Double click on the implementing class name.
You are now navigated to the class builder. Now double-click on the method name shown on the screen (see the snapshot below)
Now let us filter out the work items belonging to the task TS2000066. See the code below:
Activate the method and also the implementation. In the state of active, you wouldnt be able to make any changes. To make any changes, we need to deactivate it and then make the changes.
Now check the inbox and would notice that the work items related to that task are no more appearing.
To notice the differences, try activating and deactivating the BADi implementation.
Workflow tutorials with step-by-step and with screenshots are available at http://www.****************/Tutorials/Workflow/Workflow.htm
http://help.sap.com/saphelp_erp2005vp/helpdata/en/42/c14a9b55103116e10000000a1553f7/frameset.htm
http://help.sap.com/saphelp_erp2005vp/helpdata/en/c5/e4a930453d11d189430000e829fbbd/frameset.htm
http://www.sapgenie.com/workflow/
http://www.sap-img.com/workflow/sap-workflow.htm
http://help.sap.com/saphelp_47x200/helpdata/en/3d/6a9b3c874da309e10000000a114027/frameset.htm
http://help.sap.com/printdocu/core/Print46c/en/data/pdf/PSWFL/PSWFL.pdf
http://help.sap.com/saphelp_47x200/helpdata/en/4a/dac507002f11d295340000e82dec10/frameset.htm
http://www.workflowing.com/id18.htm
http://www.e-workflow.org/
http://web.mit.edu/sapr3/dev/newdevstand.html
http://www.sap-basis-abap.com/wf/sap-business-workflow.htm
https://forums.sdn.sap.com/click.jspa?searchID=791580&messageID=2857887
https://forums.sdn.sap.com/click.jspa?searchID=791580&messageID=2855919
https://forums.sdn.sap.com/click.jspa?searchID=791580&messageID=2735228
http://help.sap.com/printdocu/core/Print46c/en/data/pdf/BCBMTWFMSTART/BCBMTWFMSTART.pdf
http://help.sap.com/printdocu/core/Print46c/en/data/pdf/BCBMTWFMDEMO/BCBMTWFMDEMO.pdf
http://help.sap.com/printdocu/core/Print46c/en/data/pdf/BCBMTWFMPM/BCBMTWFMPM.pdf
http://help.sap.com/printdocu/core/Print46c/en/data/pdf/PSWFL/PSWFL.pdf
debug a workflow.
This has a step by step procedure :
http://fuller.mit.edu/workflow/debugging.pdf
www.erpgenie.com/sap/workflow/debugging.htm
http://www.erpgenie.com/workflow/debugging.htm?2b5de440

Documentation for AIA Tool (PIP Auditor, XMAN, Artifact Generator,Template)

Similar Messages

Maybe you are looking for