Application Services Framework (ASF) in PeopleSoft

-

               Application Services Framework (ASF) in PeopleSoft


The Application Services Framework (ASF) in PeopleSoft is a design pattern and a set of tools used to create service-oriented architecture (SOA)-based services in PeopleSoft applications. ASF supports the development of reusable, standardized, and modular services that can be consumed by internal or external systems.

🔹 Key Concepts of Application Services Framework (ASF)

  1. Service-Oriented Architecture (SOA):

    • ASF helps structure PeopleSoft functionality into services.

    • Services expose application logic in a reusable and standardized way.

  2. Components of ASF:

    • Service Definitions: High-level definition of the service (name, description, etc.).

    • Service Operations: Actual operations (methods) exposed by the service (e.g., Get, Create, Update).

    • Handlers: Application Class methods or Integration Broker transforms that implement the service logic.

    • Service Packages: Logical groupings of related services.

  3. Integration with PeopleSoft Integration Broker:

    • ASF services can be exposed as SOAP or REST web services.

    • They can also be consumed internally by PeopleCode or external clients (e.g., third-party systems).

  4. Application Classes:

    • Most ASF implementations are built using Application Packages and Classes to provide structure and reuse.

  5. Transaction and Error Handling:

    • ASF includes built-in mechanisms for logging, error management, and transaction control.

🔧 How to Use ASF in PeopleSoft

  1. Design the Service:

    • Identify reusable business logic.

    • Define inputs/outputs clearly.

  2. Create Application Package/Class:

    • Use App Designer to define logic in an Application Class.

  3. Define the Service in the Service Framework:

    • Go to: PeopleTools > Integration Broker > Integration Setup > Services

    • Create a new Service and add Service Operations.

  4. Configure the Service Operation:

    • Set up request/response messages.

    • Link the operation to your Application Class Handler.

  5. Expose the Service:

    • Activate the service for internal or external use.

    • Use WSDL for SOAP or URI templates for REST.

  6. Testing and Monitoring:

    • Use Service Operation Tester or external tools (like Postman).

    • Monitor via Integration Broker Monitor.

✅ Benefits of Using ASF

  • Promotes modular design.

  • Encourages reusability of business logic.

  • Standardized way to expose PeopleSoft functionality.

  • Enables integration with external systems (cloud, mobile, partners).

  • Supports REST and SOAP services.


Creating a Provider Application Service involves the following steps:

  1. Plan Application Service.
  2. Create an Application Class which will provide the application logic.
  3. Create Application Service.
  4. Create or import a root resource.
  5. Add URI templates.
  6. Add base template parameters to URI Template.
  7. Add method to URI template.
  8. Add input and output parameters to method.
  9. Optionally assign headers for the method.
  10. Define result states for the method.

This is the first tutorial in the Create Application Service series. Read the tutorials in the order listed.

  • Plan and Create the Application Class
  • Create the Application Service
  • Test the Application Service

Determine the Resources for your Application Service

For this tutorial, you will create an Application Service for music. The initial design should include:

  • URI Template(s)
  • Method(s)
  • Input Parameters
  • Output Parameters

This tutorial will begin by creating the Application Class that defines the application logic for the Application Service. For this Application Service, the user can retrieve the number of players and playdate for a specific instrument. It will also include the ability to post a player and music code for an instrument.

The root resource for the Application Service will include a GET and PUT method.

URI TemplateIndexMethodInput ParametersOutput Parameters
band/{instrument}1GET
instrument (string)
numPlayers (number)
playdate (date)
band/{instrument}1POSTplayer (string)
musicCode (integer)		results (string)

Create Application Class

In Application Designer create a new Application Package and Application Class that implements the application logic:

  1. In Application Designer create a new Application Package. File, New, Application Package.
  2. Select File, Save. Enter Description and click OK. Enter Name: APPSRVEXAMPLE.
  3. Right click on the package and select Insert App Class. Class Name: band.
  4. Double click band to add the code.

The application class must extend the  PCBAPPLSVCDEFN:ApplicationServiceBase application class and then implement the invokeService() method to define the application logic.

import PTCBAPPLSVCDEFN:ApplicationServiceBase;
class band extends PTCBAPPLSVCDEFN:ApplicationServiceBase;
method invokeService();
end-class;

method invokeService
/+ Extends/implements PTCBAPPLSVCDEFN:ApplicationServiceBase.invokeService +/

Define the variables for the Application Service parameters:

Local string &Inst, &httpMethod, &player, &results, &headervalue;
Local integer &UriIndex, &code;
Local time &timein;
Local date &datein;

Use the %This.ServiceAPI property to read and write parameters and other Application Services metadata.

&httpMethod = %This.ServiceAPI.HttpMethod;
&UriIndex = %This.ServiceAPI.URIIndex;

Use the HttpMethod property and URIIndex property to return the HTTP method and URI index  that was invoked for the transaction.

If &httpMethod = "GET" Then

   If &UriIndex = 1 Then

 Use the getTemplateParameter method to retrieve template value based on parameter defined on the application service. 

&Inst = %This.ServiceAPI.getTemplateParameter("instrument");

Use setOutputParameters for single row output. The code is commented out here as the tutorial will use multi row output.

<* %This.ServiceAPI.setOutputParameter("numPlayers", 10);
  %This.ServiceAPI.setOutputParameter("instrument", &Inst);
  %This.ServiceAPI.setOutputParameter("playdate", %Date);
  %This.ServiceAPI.setOutputParameter("timeout", &timein); *>

Use insertOutputRow for multi row output. For this tutorial the output is hardcoded for simplicity.

         %This.ServiceAPI.insertOutputRow();
         %This.ServiceAPI.OutputRows [1].setParameter("numPlayers", 10);
         %This.ServiceAPI.OutputRows [1].setParameter("instrument", &Inst);
         %This.ServiceAPI.OutputRows [1].setParameter("playdate", Date(20220202));
         
         %This.ServiceAPI.insertOutputRow();
         %This.ServiceAPI.OutputRows [2].setParameter("numPlayers", 6);
         %This.ServiceAPI.OutputRows [2].setParameter("instrument", &Inst);
         %This.ServiceAPI.OutputRows [2].setParameter("playdate", %Date);

Use the result state property to set the result state. Results States denote logical conclusion for the service execution.

         %This.ServiceAPI.ResultState = "SUCCESS - PLAY MUSIC";
      End-If;
   End-If;

Next you will enter the code for the POST.


If &httpMethod  = "POST" Then
If &UriIndex = 1 Then

Optionally you can add request and response headers. For this example, we will add both a request and response header to the POST.

Use getRequestHeaderValue to retrieve header value based  on header defined on the application service. Use setResponseHeader to set the response header value based on header defined on the application service.

&headervalue = %This.ServiceAPI.getRequestHeaderValue("Accept-Language");

%This.ServiceAPI.setResponseHeader("Type","Woodwind");

 Use the getTemplateParameter method to retrieve template value based on parameter defined on the application service.

&Inst = %This.ServiceAPI.getTemplateParameter("instrument");

Use the InputRows property to get values on the specified row.

&player = %This.ServiceAPI.InputRows[1].getParameter("player");

&Inst = %This.ServiceAPI.InputRows[1].getParameter("instrument");

&code = %This.ServiceAPI.InputRows[1].getParameter("musicCode");

&player = %This.ServiceAPI.InputRows[2].getParameter("player");

&Inst = %This.ServiceAPI.InputRows[2].getParameter("instrument");

&code = %This.ServiceAPI.InputRows[2].getParameter("musicCode");

Use the setOutputParameter to set output value based on parameter defined on the application service. (single row output)

%This.ServiceAPI.setOutputParameter("results", "Players added");

Use the result state property to set the result state.This is also the end of the if statement and end of the method.

        %This.ServiceAPI.ResultState = "Success";
      End-If;
   End-If;
   
end-method;

Source : Oracle PeopleSoft Learning Documentations / https://docs.oracle.com/

Stay tuned for more information.

Comments

Post a Comment

Popular posts from this blog

PeopleSoft Meta Tables

-
Application Engine Meta Data PSAEAPPLDEFN AE header record; 1 row per app engine PSAEAPPLSTATE AE state records (shows which one is the default) PSAEAPPLTEMPTBL AE temp tables assigned PSAESECTDEFN AE sections: public or private PSAESECTDTLDEFN AE section: descriptions, market, DB Type, EFFDT, EFF_STATUS, and auto commit PSAESTEPDEFN AE steps within section: description, market, DB Type, EFFDT, EFF_STATUS PSAESTMTDEFN AE actions within AE step: Step type (SQL, Do Select, etc.) with SQLID. PSAESTEPMSGDEFN AE message (parameters in each step) AEREQUESTPARM AE request parameters table behind the AE run control page. Find All Records Referenced in App Engine 1. Find the Temp Records (TAO) that are used: SELECT RECNAME FROM PSAEAPPLTEMPTBL WHERE AE_APPLID = 'MY_APP_PROGRAM_NAME' 2. If there are records, find the number of instances: SELECT TEMPTBLINSTANCES FROM PSAEAPPLDEFN WHERE AE_APPLID = 'MY_APP_PROGRAM_NAME...
Read more

Peoplesoft Application Package, Application Class and Application Method Implementation

-
Application Classes in PeopleSoft Defining and Importing packages or classes in PeopleCode <Pacakge name>:<Subpacakge name>:<…>:<Class name or wild card> Class Extensions represents the “is-a” relationship.   When a class extends another class, it’s called a subclass of that class. No Multiple inheritances or Concept of interface in Application classes. Instance variables in the class are accessible in all the objects of that class. Application programs generally pass parameters by value, which is not the same as for existing functions. Parameter passing with object data types is by reference. When the objects are passed to method and it reassign the object with new object it will not reflected in the calling method. Application Programs use the out specifier to pass a parameter by reference. Method increment (&Value as number out); rem passed by reference.   Create is the key word used to create the class object.  ...
Read more

Peoplesoft Application Package - Application Class/Application Package peoplecode and Calling them anywhere

-
Peoplesoft Application Package - Define Application Class and Calling Application class and Application Class Method from any Peoplecode event:  Step 1: Create New Application Package - MYPACKAGE Step2: Add a new application class in it. - MyClass Step 3: Defining Class and methods inside (Public or Private) 1. We can define classes here 2. We can define methods here 3. We can define Class Property Code to write inside a class to define class and its method: class MyClass method MyMethod (&smyInput as String, &nmyInput as Number) returns string; private method MyPrivateMethod (&sInput as String) returns boolean; property string &sVar; property number &nVar; end-class; method MyMethod /*+Method Body+*/ returns &sVar; end-method; method MyPrivateMethod  /*+Method Body+*/ returns &bVar; end-method; Code to write call a class and run its method: import MYPACKAGE:MyClass; Local string &sGetMethodData; Local MYPACKAGE:MyClass &oClassObjectVar...
Read more