Oracle® Common Application Components: API Reference Guide Release 11i

Oracle® Common Application Components
API Reference Guide

Release 11i
Part No. B10562-01
March 2003
Oracle Common Application Components API Reference Guide, Release 11i
Part No. B10562-01
Copyright © 2000, 2003 Oracle Corporation. All rights reserved.
Primary Authors: Charles Colt, Melody Yang
Contributing Authors: Kellie Briesach, Carol Fager-Higgins, Robert Geiwitz
Contributors: Remi Aimsuphanimit, Sarvi Anandan, Huub Bouten, Kalyani Venkat Chervela, Kenny
Ching, Sudarsana Choudhury, Rada Despotovic, Conrad Dias, Ravi Epuri, Killian Evers, Girish Mohan
Jashnani, Inna Kitaina, Leela Krishna, Milan Marovic, Sharad Mathur, Chirag Mehta, Suma Neeruganti,
John-Tae Park, Hari Radhakrishnan, Peter Pil Seo, Rajesh Singh, Nimit B. Thaker, Jane Wang, Ray Wang,
Roger Wigenstam
The Programs (which include both the software and documentation) contain proprietary information of
Oracle Corporation; they are provided under a license agreement containing restrictions on use and
disclosure and are also protected by copyright, patent and other intellectual and industrial property
laws. Reverse engineering, disassembly or decompilation of the Programs, except to the extent required
to obtain interoperability with other independently created software or as specified by law, is prohibited.
The information contained in this document is subject to change without notice. If you find any problems
in the documentation, please report them to us in writing. Oracle Corporation does not warrant that this
document is error-free. Except as may be expressly permitted in your license agreement for these
Programs, no part of these Programs may be reproduced or transmitted in any form or by any means,
electronic or mechanical, for any purpose, without the express written permission of Oracle Corporation.
If the Programs are delivered to the U.S. Government or anyone licensing or using the programs on
behalf of the U.S. Government, the following notice is applicable:
Restricted Rights Notice Programs delivered subject to the DOD FAR Supplement are "commercial
computer software" and use, duplication, and disclosure of the Programs, including documentation,
shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement.
Otherwise, Programs delivered subject to the Federal Acquisition Regulations are "restricted computer
software" and use, duplication, and disclosure of the Programs shall be subject to the restrictions in FAR
52.227-19, Commercial Computer Software - Restricted Rights (June, 1987). Oracle Corporation, 500
Oracle Parkway, Redwood City, CA 94065.
The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently
dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup,
redundancy, and other measures to ensure the safe use of such applications if the Programs are used for
such purposes, and Oracle Corporation disclaims liability for any damages caused by such use of the
Programs.
Oracle is a registered trademark, and PL/SQL, OracleMetaLink, and SQL*Plus are trademarks or registered
trademarks of Oracle Corporation. Other names may be trademarks of their respective owners.
Contents
Send Us Your Comments .................................................................................................................. vii
Preface............................................................................................................................................................ ix
Audience for This Guide ...................................................................................................................... ix
How To Use This Guide ........................................................................................................................ x
Typographic Conventions ..................................................................................................................... x
Documentation Accessibility ............................................................................................................... xi
Other Information Sources .................................................................................................................. xii
Do Not Use Database Tools to Modify Oracle Applications Data .............................................. xvii
About Oracle ....................................................................................................................................... xvii
1 Introduction
1.1 Parameter Specifications ...................................................................................................... 1-2
1.1.1 Standard IN Parameters................................................................................................ 1-3
1.1.2 Standard OUT Parameters............................................................................................ 1-4
1.1.3 Parameter Size ................................................................................................................ 1-5
1.1.4 Missing Parameter Attributes ...................................................................................... 1-5
1.1.5 Parameter Validations ................................................................................................... 1-5
1.1.6 Invalid Parameters ......................................................................................................... 1-6
1.2 Version Information.............................................................................................................. 1-6
1.3 Status Messages ..................................................................................................................... 1-6
2 Resource Manager Public APIs

2.1 Resource Manager Public Packages ................................................................................... 2-1
2.1.1 Resource Manager Public APIs .................................................................................... 2-2
2.2 Package JTF_RS_RESOURCE_PUB .................................................................................... 2-3
2.2.1 Create_Resource ............................................................................................................. 2-3
2.2.2 Update_Resource ......................................................................................................... 2-11
2.3 Package JTF_RS_GROUPS_PUB ....................................................................................... 2-19
iii
2.3.1 Create_Resource_Group.............................................................................................. 2-19
2.3.2 Update_Resource_Group............................................................................................ 2-21
2.4 Package JTF_RS_SALESREPS_PUB .................................................................................. 2-24
2.4.1 Create_SalesRep ........................................................................................................... 2-24
2.4.1.1 Setting the org_context ......................................................................................... 2-25
2.4.2 Update_SalesRep.......................................................................................................... 2-28
2.4.2.1 Setting the org_context ......................................................................................... 2-28
2.5 Messages and Notifications ............................................................................................... 2-32
2.5.1 JTF_RS_RESOURCE_PUB........................................................................................... 2-32
2.5.1.1 Create_Resource .................................................................................................... 2-32
2.5.1.2 Update_Resource .................................................................................................. 2-35
2.5.2 JTF_RS_GROUPS_PUB................................................................................................ 2-37
2.5.2.1 Create_Resource_Group ...................................................................................... 2-37
2.5.2.2 Update_Resource_Group..................................................................................... 2-38
2.5.3 JTF_RS_SALESREPS_PUB .......................................................................................... 2-39
2.5.3.1 Create_SalesRep .................................................................................................... 2-39
2.5.3.2 Update_SalesRep................................................................................................... 2-41
2.6 Sample Code......................................................................................................................... 2-42
2.6.1 JTF_RS_RESOURCE_PUB........................................................................................... 2-42
2.6.1.1 Create_Resource .................................................................................................... 2-42
2.6.1.2 Update_Resource .................................................................................................. 2-45
2.6.2 JTF_RS_GROUPS_PUB................................................................................................ 2-49
2.6.2.1 Create_Resource_Group Sample Code.............................................................. 2-49
2.6.2.2 Update_Resource_Group Sample Code ............................................................ 2-51
2.6.3 JTF_RS_SALESREPS_PUB .......................................................................................... 2-53
2.6.3.1 Create_SalesRep Sample Code............................................................................ 2-53
2.6.3.2 Update_SalesRep Sample Code .......................................................................... 2-55
3 Task Manager Public APIs

3.1 Task Manager Public Packages ........................................................................................... 3-2
3.2 Package JTF_TASKS_PUB.................................................................................................... 3-5
3.2.1 Data Structure Specifications........................................................................................ 3-5
3.2.1.1 Task Assign Record Type....................................................................................... 3-5
3.2.1.2 Task Dependency Record Type ............................................................................ 3-6
3.2.1.3 Task Reference Record Type ................................................................................. 3-6
iv
3.2.1.4 Task Recurrence Record Type............................................................................... 3-7
3.2.1.5 Task Dates Record Type......................................................................................... 3-7
3.2.1.6 Task Contact Record Type..................................................................................... 3-7
3.2.1.7 Task Notes Record Type ........................................................................................ 3-8
3.2.1.8 Sort Record Type..................................................................................................... 3-8
3.2.2 Create_Task..................................................................................................................... 3-9
3.2.3 Update_Task ................................................................................................................. 3-19
3.2.4 Delete_Task ................................................................................................................... 3-27
3.3 Package JTF_TASKS_ASSIGNMENTS_PUB................................................................... 3-29
3.3.1 Data Structure Specifications...................................................................................... 3-29
3.3.1.1 Task Assignments Record Type.......................................................................... 3-29
3.3.2 Create_Task_Assignment ........................................................................................... 3-30
3.3.3 Update_Task_Assignment.......................................................................................... 3-36
3.3.4 Delete_Task_Assignment............................................................................................ 3-40
3.4 Package JTF_TASK_REFERENCES_PUB ........................................................................ 3-42
3.4.1 Data Structure Specifications...................................................................................... 3-42
3.4.1.1 References Record Type....................................................................................... 3-42
3.4.2 Create_References ........................................................................................................ 3-43
3.4.3 Update_References ...................................................................................................... 3-46
3.4.4 Delete_References ........................................................................................................ 3-49
3.5.1 Common Messages ...................................................................................................... 3-51
3.5.2 JTF_TASK_ASSIGNMENTS_PUB ............................................................................. 3-54
3.5.3 JTF_TASK_REFERENCES_PUB................................................................................. 3-54
3.5.4 JTF_TASKS_PUB .......................................................................................................... 3-55
3.6 Sample Code ........................................................................................................................ 3-56
3.6.1 Package JTF_TASKS_PUB .......................................................................................... 3-57
3.6.2 Package JTF_TASK_ASSIGNMENTS_PUB ............................................................. 3-61
3.6.3 Package JTF_TASK_REFERENCES_PUB ................................................................. 3-64
4 Notes Public APIs

4.1 Package JTF_NOTES_PUB................................................................................................... 4-1
4.1.1 Data Structure Specifications........................................................................................ 4-2
4.1.1.1 Record jtf_note_contexts_rec_type....................................................................... 4-2
4.1.2 Notes Public APIs........................................................................................................... 4-2
v
4.1.3 Note Source and Note Context..................................................................................... 4-2
4.1.3.1 Note Source .............................................................................................................. 4-3
4.1.3.2 Note Context ............................................................................................................ 4-3
4.1.4 Party Relationships ........................................................................................................ 4-4
4.1.5 Create_Note..................................................................................................................... 4-5
4.1.6 Update_Note ................................................................................................................. 4-11
4.2.1 JTF_NOTES_PUB ......................................................................................................... 4-14
4.3 Sample Code......................................................................................................................... 4-14
4.3.1 Package JTF_NOTES_PUB.......................................................................................... 4-14
4.3.1.1 Create_Note ........................................................................................................... 4-15
4.3.1.2 Update_Note.......................................................................................................... 4-17
Index
vi
Send Us Your Comments
Oracle Common Application Components API Reference Guide, Release 11i
Part No. B10562-01
Oracle Corporation welcomes your comments and suggestions on the quality and usefulness of this
publication. Your input is an important part of the information used for revision.
■ Did you find any errors?
■ Is the information clearly presented?
■ Do you need more information? If so, where?
■ Are the examples correct? Do you need more examples?
■ What features did you like most about this manual?
If you find any errors or have any other suggestions for improvement, please indicate the chapter,
section, and page number (if available). You can send comments to us at:
Oracle Corporation
Oracle Common Application Components, Content Development Manager
500 Oracle Parkway
Redwood Shores, CA 94065
USA
If you would like a reply, please give your name, address, and telephone number below.
vii
viii
Preface
Audience for This Guide

Welcome to Release 11i of the Oracle Common Application Components API Reference
Guide. This manual describes the Oracle Common Application Components’ public
APIs, and provides information to help you work effectively with these public APIs.
Note: This document provides API information for the following

Oracle Common Application Components only:
■ Resource Manager
■ Task Manager
■ Notes
This guide assumes you have a working knowledge of the following:

■ The principles and customary practices of your business area
■ Oracle Common Application Components
If you have never used the Oracle Common Application Components modules,
Oracle suggests you attend one or more of the Oracle Common Application
Components training classes available through Oracle University.
■ The Oracle Applications graphical user interface
To learn more about the Oracle Applications graphical user interface, read the
Oracle Applications User’s Guide. See "Other Information Sources" for more
information about Oracle Applications product information.
ix
This preface explains how the Reference Guide is organized and introduces other
sources of information that can help you.
How To Use This Guide

This manual contains the following chapters:
Chapter Title Summary

Chapter 1 Introduction Discusses the following topics:
■ API and parameter specifications
■ Standard IN and OUT parameters
■ Status messages
Chapter 2 Resource Manager Discusses the following Resource Manager
Public APIs public packages, and the associated public
APIs:
■ JTF_RESOURCES_PUB
■ JTF_RS_GROUP_PUB
■ JTF_RS_SALESREPS_PUB
Chapter 3 Task Manager Public Discusses the following Task Manager public
APIs packages, and the associated public APIs:
■ JTF_TASKS_PUB
■ JTF_TASK_ASSIGNMENT_PUB
■ JTF_TASK_REFERENCES_PUB
Chapter 4 Notes Public APIs Discusses the Notes public package (JTF_
NOTES_PUB), and the associated public APIs.
Typographic Conventions
This document uses the following typographic conventions:
Convention Description
Monospace text Monospace text represents code or SQL statements.
x
Convention Description
lowercase italics Lowercase italics in the text represent variables.
Substitute an appropriate value for the variable.
UPPERCASE Uppercase characters within the text represent command
names, SQL reserved words and keywords, and terms
associated with the Oracle database.
Indentation Indentation helps to show structure within code
examples, but is not required.
<text> Text inside angle brackets can mean either of the
following:
■ It denotes a variable that is replaced with an actual value at
runtime.
■ In indicates XML elements in discussions about XML code.
Documentation Accessibility
Our goal is to make Oracle products, services, and supporting documentation
accessible, with good usability, to the disabled community. To that end, our
documentation includes features that make information available to users of
assistive technology. This documentation is available in HTML format, and contains
markup to facilitate access by the disabled community. Standards will continue to
evolve over time, and Oracle Corporation is actively engaged with other
market-leading technology vendors to address technical obstacles so that our
documentation can be accessible to all of our customers. For additional information,
visit the Oracle Accessibility Program Web site at
http://www.oracle.com/accessibility/
Accessibility of Code Examples in Documentation

JAWS, a Windows screen reader, may not always correctly read the code examples
in this document. The conventions for writing code require that closing braces
should appear on an otherwise empty line; however, JAWS may not always read a
line of text that consists solely of a bracket or brace.
xi
Accessibility of Links to External Web Sites in Documentation
This documentation may contain links to Web sites of other companies or
organizations that Oracle Corporation does not own or control. Oracle Corporation
neither evaluates nor makes any representations regarding the accessibility of these
Web sites.
Other Information Sources

You can choose from many sources of information, including online documentation,
training, and support services, to increase your knowledge and understanding of
Oracle Common Application Components.
If this guide refers you to other Oracle Applications documentation, use only the
Release 11i versions of those guides.
Online Documentation
All Oracle Applications documentation is available online (HTML or PDF). Online
help patches are available on MetaLink.
Related Documentation
Oracle Common Application Components shares business and setup information
with other Oracle Applications products. Therefore, you may want to refer to other
product documentation when you set up and use Oracle Common Application
Components
You can read the documents online by reading from the Oracle Applications
Document Library CD included in your media pack, or by using a Web browser
with a URL that your system administrator provides.
If you require printed guides, you can purchase them from the Oracle Store at
http://oraclestore.oracle.com.
Documents Related to All Products
Oracle Applications User’s Guide

This guide explains how to enter data, query, run reports, and navigate using the
graphical user interface (GUI) available with this release of Oracle Common
Application Components (and any other Oracle Applications products). This guide
also includes information on setting user profiles, as well as running and reviewing
reports and concurrent processes.
xii
You can access this user’s guide online by choosing”Getting Started with Oracle
Applications” from any Oracle Applications help file.
Documents Related to This Product
Oracle Common Application Components Implementation Guide

Use this manual to understand the necessary configuration and setup steps that
need to be performed after the Oracle Common Application Components modules
are installed.
Oracle Common Application Components User’s Guide

This manual provides basic conceptual and reference information needed to
understand the Oracle Common Application Components modules. In addition, it
details the procedures performed by a typical end-user of the Oracle Common
Application Components modules.
Installation and System Administration
Oracle Applications Concepts

This guide provides an introduction to the concepts, features, technology stack,
architecture, and terminology for Oracle Applications Release 11i. It provides a
useful first book to read before an installation of Oracle Applications. This guide
also introduces the concepts behind Applications-wide features such as Business
Intelligence (BIS), languages and character sets, and Self-Service Web Applications.
Installing Oracle Applications

This guide provides instructions for managing the installation of Oracle
Applications products. In Release 11i, much of the installation process is handled
using Oracle Rapid Install, which minimizes the time to install Oracle Applications,
the Oracle8 technology stack, and the Oracle8i Server technology stack by
automating many of the required steps. This guide contains instructions for using
Oracle Rapid Install and lists the tasks you need to perform to finish your
installation. You should use this guide in conjunction with individual product
user’s guides and implementation guides.
xiii
Oracle Applications Supplemental Common Application Components
Installation Steps
This guide contains specific steps needed to complete installation of a few of the
Common Application Components products. The steps should be done
immediately following the tasks given in the Installing Oracle Applications guide.
Upgrading Oracle Applications

Refer to this guide if you are upgrading your Oracle Applications Release 10.7 or
Release 11.0 products to Release 11i. This guide describes the upgrade process and
lists database and product-specific upgrade tasks. You must be either at Release 10.7
(NCA, SmartClient, or character mode) or Release 11.0, to upgrade to Release 11i.
You cannot upgrade to Release 11i directly from releases prior to 10.7.
Maintaining Oracle Applications

Use this guide to help you run the various AD utilities, such as AutoUpgrade,
AutoPatch, AD Administration, AD Controller, AD Relink, License Manager, and
others. It contains how-to steps, screenshots, and other information that you need to
run the AD utilities. This guide also provides information on maintaining the
Oracle applications file system and database.
Oracle Applications System Administrator’s Guide

This guide provides planning and reference information for the Oracle Applications
System Administrator. It contains information on how to define security, customize
menus and online help, and manage concurrent processing.
Oracle Alert User’s Guide

This guide explains how to define periodic and event alerts to monitor the status of
your Oracle Applications data.
Oracle Applications Developer’s Guide

This guide contains the coding standards followed by the Oracle Applications
development staff. It describes the Oracle Application Object Library components
needed to implement the Oracle Applications user interface described in the Oracle
Applications User Interface Standards for Forms-Based Products. It also provides
information to help you build your custom Oracle Forms Developer 6i forms so that
they integrate with Oracle Applications.
xiv
Oracle Applications User Interface Standards for Forms-Based Products
This guide contains the user interface (UI) standards followed by the Oracle
Applications development staff. It describes the UI for the Oracle Applications
products and how to apply this UI to the design of an application built by using
Oracle Forms.
Other Implementation Documentation
Oracle Workflow Administrator's Guide

This guide explains how to complete the setup steps necessary for any Oracle
Applications product that includes workflow-enabled processes, as well as how to
monitor the progress of runtime workflow processes.
Oracle Workflow Developer's Guide

This guide explains how to define new workflow business processes and customize
existing Oracle Applications-embedded workflow processes. It also describes how
to define and customize business events and event subscriptions.
Oracle Workflow User's Guide

This guide describes how Oracle Applications users can view and respond to
workflow notifications and monitor the progress of their workflow processes.
Oracle Workflow API Reference

This guide describes the APIs provided for developers and administrators to access
Oracle Workflow.
Oracle eTechnical Reference Manuals

Each eTechnical Reference Manual (eTRM) contains database diagrams and a
detailed description of database tables, forms, reports, and programs for a specific
Oracle Applications product. This information helps you convert data from your
existing applications, integrate Oracle Applications data with non-Oracle
applications, and write custom reports for Oracle Applications products. Oracle
eTRM is available on Metalink
Oracle Manufacturing APIs and Open Interfaces Manual

This manual contains up-to-date information about integrating with other Oracle
Manufacturing applications and with your other systems. This documentation
includes APIs and open interfaces found in Oracle Manufacturing.
xv
Oracle Order Management Suite APIs and Open Interfaces Manual
This manual contains up-to-date information about integrating with other Oracle
Manufacturing applications and with your other systems. This documentation
includes APIs and open interfaces found in Oracle Order Management Suite.
Oracle Applications Message Reference Manual

This manual describes Oracle Applications messages. This manual is available in
HTML format on the documentation CD-ROM for Release 11i.
Training and Support
Training
Oracle offers training courses to help you and your staff master the Oracle Common
Application Components modules and reach full productivity quickly. You have a
choice of educational environments:
■ You can attend courses offered by Oracle University at any one of our many
Education Centers.
■ You can arrange for our trainers to teach at your facility.
■ You can use Oracle Learning Network (OLN), Oracle University's online
education utility.
In addition, Oracle training professionals can tailor standard courses or develop
custom courses to meet your needs. For example, you may want to use your
organization’s structure, terminology, and data as examples in a customized
training session delivered at your own facility.
Support
From on-site support to central support, our team of experienced professionals
provides the help and information you need to keep the Oracle Common
Application Components modules working for you. This team includes your
Technical Representative, Account Manager, and Oracle’s large staff of consultants
and support specialists with expertise in your business area, managing an Oracle8i
server, and your hardware and software environment.
OracleMetaLink
OracleMetaLink is your self-service support connection with Web, telephone menu,
and e-mail alternatives. Oracle supplies these technologies for your convenience,
available 24 hours a day, 7 days a week. With OracleMetaLink, you can obtain
xvi
information and advice from technical libraries and forums, download patches,
download the latest documentation, look at bug details, and create or update TARs.
To use MetaLink, register at (http://metalink.oracle.com).
Alerts: You should check OracleMetaLink alerts before you begin to install or
upgrade any of your Oracle Applications. Navigate to the Alerts page as follows:
Technical Libraries/ERP Applications/Applications Installation and
Upgrade/Alerts.
Self-Service Toolkit: You may also find information by navigating to the
Self-Service Toolkit page as follows: Technical Libraries/ERP
Applications/Applications Installation and Upgrade.
Do Not Use Database Tools to Modify Oracle Applications Data

Oracle STRONGLY RECOMMENDS that you never use SQL*Plus, Oracle Data
Browser, database triggers, or any other tool to modify Oracle Applications data
unless otherwise instructed.
Oracle provides powerful tools you can use to create, store, change, retrieve, and
maintain information in an Oracle database. But if you use Oracle tools such as
SQL*Plus to modify Oracle Applications data, you risk destroying the integrity of
your data and you lose the ability to audit changes to your data.
Because Oracle Applications tables are interrelated, any change you make using
Oracle Applications can update many tables at once. But when you modify Oracle
Applications data using anything other than Oracle Applications, you may change a
row in one table without making corresponding changes in related tables. If your
tables get out of synchronization with each other, you risk retrieving erroneous
information and you risk unpredictable results throughout Oracle Applications.
When you use Oracle Applications to modify your data, Oracle Applications
automatically checks that your changes are valid. Oracle Applications also keeps
track of who changes information. If you enter information into database tables
using database tools, you may store invalid information. You also lose the ability to
track who has changed your information because SQL*Plus and other database
tools do not keep a record of changes.
About Oracle
Oracle Corporation develops and markets an integrated line of software products
for database management, applications development, decision support, and office
automation, as well as Oracle Applications, an integrated suite of more than 160
xvii
software modules for financial management, supply chain management,
manufacturing, project systems, human resources and customer relationship
management.
Oracle products are available for mainframes, minicomputers, personal computers,
network computers and personal digital assistants, allowing organizations to
integrate different computers, different operating systems, different networks, and
even different database management systems, into a single, unified computing and
information resource.
Oracle is the world’s leading supplier of software for information management, and
the world’s second largest software company. Oracle offers its database, tools, and
applications products, along with related consulting, education, and support
services, in over 145 countries around the world.
xviii
1
Introduction
The Oracle e-Business Suite contains the following types of APIs:

■ Private APIs are for internal, development use only. Details are not provided to
anyone outside of the immediate development environment, nor are they
intended for use by anyone outside of the e-Business Suite development
environment.
■ Public APIs are designed for customers and Oracle consultants to integrate
non-Oracle systems into Oracle e-Business Suite or to extend the functionality
of the base products. Oracle does not support public APIs unless they are
published in a reference manual such as this one. The user accepts all risk and
responsibility for working with non-published public APIs.
■ Public, published APIs are guaranteed by Oracle to remain valid from release
to release and that patches will not alter the API behavior. Public, published
APIs are supported by Oracle to the same extent as released software.
For non-published APIs, Oracle expressly does not provide any guarantees
regarding consistency of naming, usage, or behavior of any API (public or private)
between releases. It is also possible that a patch could alter any characteristic of any
non-published e-Business Suite API. As such, those who choose to use these APIs
do so at their own risk. However, Oracle does attempt to minimize all changes to
public APIs, even if not published.
Introduction 1-1
Parameter Specifications
Note: In Applications release 11.5.9, many of the Applications'

PL/SQL server side APIs have been enhanced to utilize the pass by
reference semantics of PL/SQL. This improves performance
considerably and reduces memory consumption. In the normal
processing case (i.e. success), there is no change of behavior, and
callers of these APIs are not impacted. However, in the case of
exceptions, there is a behavior change which results in assignments
being exposed to the caller, which are made in the API prior to any
exceptions being raised. The previous behavior would rollback
these assignments made by the API if an exception occurred in this
API. Developers writing custom extensions to Oracle Applications,
or third party integrators which use the standard Applications'
APIs should be aware of this change in semantics.
The Common Application Components APIs

The public APIs provided by the Oracle Common Application Components and
described in this document are divided into groups of public packages. There are
one or more packages for each of the following Oracle Common Application
Components modules covered here:
■ Resource Manager
■ Task Manager
■ Notes
Each published API provides an API specification, and definitions as for its
parameters, data structures, and status messages. Sample scripts and documented
process flow diagrams are included where applicable.
Note: The words procedure and API are used interchangeably in

this document.
1.1 Parameter Specifications

The specifications for the public APIs provided by the Oracle Common Application
Components define four categories of parameters:
■ Standard IN
■ Standard OUT
1-2 Oracle Common Application Components API Reference Guide

■ Procedure specific IN
■ Procedure specific OUT
Standard IN and OUT parameters are specified by the Oracle Applications business
object API Coding Standards, and are discussed in the following sections.
Procedure specific IN and OUT parameter are related to the API being specified,
and are discussed with that individual API.
1.1.1 Standard IN Parameters

The following table describes standard IN parameters, which are common to all
public APIs provided by Oracle Common Application Components.
Table 1–1 Standard IN Parameters

Parameter Data Type Required Description
p_api_version NUMBER Yes This must match the version number of the
API. An unexpected error is returned if the
calling program version number is
incompatible with the current API version
number (provided in the documentation).
p_init_msg_list VARCHAR2 Yes The valid values for this parameter are:
■ True = FND_API.G_TRUE
■ False = FND_API.G_FALSE
■ Default = FND_API.G_FALSE
If set to true, then the API makes a call to
fnd_msg_pub.initialize to initialize the
message stack. To set to true, use the value,
"T".
If set to false then the calling program
must initialize the message stack. This
action is required to be performed only
once, even in the case where more than
one API is called. To set to false, use the
value, "F".
Introduction 1-3
Table 1–1 Standard IN Parameters

Parameter Data Type Required Description
p_commit VARCHAR2(1) No The valid values for this parameter are:

■ True = FND_API.G_TRUE
■ False = FND_API.G_FALSE
■ Default = FND_API.G_FALSE
If set to true, then the API commits before
returning to the calling program. To set to
true, use the value, "T".
If set to false, then it is the calling
program’s responsibility to commit the
transaction. To set to false, use the value,
"F".
1.1.2 Standard OUT Parameters

The following table describes standard OUT parameters, which are common to all
public APIs provided by Oracle Common Application Components.
Note: All standard OUT parameters are required.
Table 1–2 Standard OUT Parameters

Parameter Data Type Description
x_return_status VARCHAR2(1) Indicates the return status of the API. The values
returned are one of the following:
■ FND_API.G_RET_STS_SUCCESS
Success: Indicates the API call was successful
■ FND_API.G_RET_STS_ERROR
Expected Error: There is a validation error, or
missing data error.
■ FND_API.G_RET_STS_UNEXP_ERROR
Unexpected Error: The calling program can not
correct the error.
x_msg_count NUMBER Holds the number of messages in the message list.

Table 1–2 Standard OUT Parameters

x_msg_data VARCHAR2(2000) Holds the encoded message if x_msg_count is equal
to one.
1.1.3 Parameter Size

Verify the size of the column from the base table for that column when passing a
parameter of a specific length. For example, if you pass a NUMBER value, first
query to find the exact value to pass. An incorrect value can cause the API call to
fail.
1.1.4 Missing Parameter Attributes

The following table describes optional IN parameters which are initialized to
pre-defined values representing missing constants. These constants are defined for
the common PL/SQL data types and should be used in the initialization of the API
formal parameters.
Table 1–3 Initialized IN Parameters

Parameter Type Initialized Value
G_MISS_NUM CONSTANT NUMBER:= 9.99E125
G_MISS_CHAR CONSTANT VARCHAR2(1):= chr(0)
G_MISS_DATE CONSTANT DATE:= TO_DATE('1','j');
These constants are defined in the package FND_API in the file fndpapis.pls. All
columns in a record definition are set to the G_MISS_X constant as defined for the
data type.
1.1.5 Parameter Validations

The following types of parameters are always validated during the API call:
■ Standard IN
■ Standard OUT
■ Mandatory procedure specific IN
■ Procedure specific OUT
Introduction 1-5
Version Information
1.1.6 Invalid Parameters

If the API encounters any invalid parameters during the API call, then one of the
following actions will occur:
■ An exception is raised.
■ An error message identifying the invalid parameter is generated.
■ All API actions are cancelled.
1.2 Version Information

It is mandatory that every API call pass a version number for that API as its first
parameter (p_api_version).
This version number must match the internal version number of that API. An
unexpected error is returned if the calling program version number is incompatible
with the current API version number.
Warning: The currently supported version at this time is 1.0. Use

only this for the API version number.
In addition, the object version number must be input for all update and delete APIs.
■ If the object_version_number passed by the API matches that of the object in the
database, then the update is completed.
■ If the object_version_number passed by the API does not match that of the object
in the database, then an error condition is generated.
1.3 Status Messages

Note: It is not required that all status notifications provide a
number identifier along with the message, although, in many cases,
it is provided.
Every API must return one of the following states as parameter x_return_status after
the API is called:
■ S (Success)

Status Messages
■ E (Error)
■ U (Unexpected error)
Each state can be associated with a status message. The following table describes
each state.
Table 1–4 Status Message and Description
Status Description
S Indicates that the API performed all the operations requested by its caller.
■ A success return status may or may not be accompanied by messages in
the API message list.
■ Currently, the Oracle Common Application Components APIs do not
provide a message for a return status of success.
E Indicates that the API failed to perform one or more of the operations
requested by its caller.
An error return status is accompanied by one or more messages describing
the error.
U Indicates that the API encountered an error condition it did not expect, or
could not handle, and that it is unable to continue with its regular processing.
■ For example, certain programming errors such as attempting to divide by
zero causes this error.
■ These types of errors usually cannot be corrected by the user and
requires a system administrator or application developer to correct.
Warning and Information Messages

In addition to these three types of possible status messages, you can also code the
following additional message types:
■ Warnings
■ Information
To create a warning message, perform the following steps:
1. Create a global variable to be used to signal a warning condition. For example,
this could be similar to the following:
G_RET_STS_WARNING := 'W’
This global variable is not part of the FND_API package.
Introduction 1-7
Status Messages
2. Return this value if the warning condition is encountered. For example, using
the same example as in step one, set up the following code in the API to process
the warning condition:
x_return_status := G_RET_STS_WARNING
This code replaces the more usual:

x_return_status := fnd_api.g_ret_sts_unexp_error for "U"
3. If desired, perform a similar procedure to create Information messages.

2
Resource Manager Public APIs
Resource Manager provides the Common Application Components with a common

framework for importing, defining and viewing resources, creating teams and
groups, and organizing resources within those teams and groups. Other Common
Application Components access resources through Resource Manager. Resource
Manager acts as the central repository and provides a consistent API interface for
working with resources.
The following topics are discussed in this chapter:
■ Resource Manager Public Packages
■ Messages and Notifications
■ Sample Code
2.1 Resource Manager Public Packages

There are three public Resource Manager packages:
■ Package JTF_RS_RESOURCE_PUB
■ Package JTF_RS_GROUPS_PUB
■ Package JTF_RS_SALESREPS_PUB
Package JTF_RS_RESOURCE_PUB
All public procedures (APIs) relating to creating or updating a resource are stored in
package JTF_RS_RESOURCE_PUB. This package contains the following APIs:
■ Create_Resource
■ Update_Resource
Resource Manager Public APIs 2-1

Resource Manager Public Packages
Package JTF_RS_GROUPS_PUB
All public procedures (APIs) relating to creating or updating a resource group are
stored in package JTF_RS_GROUPS_PUB. This package contains the following
APIs:
■ Create_Resource_Group
■ Update_Resource_Group
Package JTF_RS_SALESREPS_PUB
All public procedures (APIs) relating to creating or updating a salesperson are
stored in package JTF_RS_SALESREPS_PUB. This package contains the following
APIs:
■ Create_SalesRep
■ Update_SalesRep
2.1.1 Resource Manager Public APIs

The following table describes the public APIs which are discussed in this chapter.
Table 2–1 Resource Manager Public APIs

Procedure Description
Create_Resource Creates all categories of resources like Employee, Party, Supplier
Contact, Other, Partner, and To Be Hired.
Update_Resource Updates resource attributes like Resource Name, Start Date, End
Date, and User Identifier.
Create_Resource_Group Creates a Resource Group.
Update_Resource_ Updates Resource Group attributes such as Group Name,
Group Group Description, Start and End Date effectively.
Create_SalesRep Creates a salesperson. The API verifies the resource ID
parameter from the jtf_rs_resourc_.extns table.
Update_SalesRep Updates SalesRep attributes like SalesRep Number, Sales Credit
Type, Start and End Date effectively.

2.2 Package JTF_RS_RESOURCE_PUB

This package contains the following APIs:
■ Create_Resource
■ Update_Resource
2.2.1 Create_Resource
The Create_Resource API create s all resource categories including Employee, Party,
Supplier Contact, and Other. Before creating the resource, the
Create_Resource API first determines that it does not exist in the Resources table.
After in creates the resource, the API inserts Call Center, Compensation, and
Account Receivables information that pertain to the resource into resource tables
and generates the following unique identifiers:
■ resource_id
■ resource_number
Resource Information versus Source Information

Within the Resource Manager, resource information and source information are two
different types of information.
■ Resource information (name, number, category, and similar items) is defined
within the Resource Manager, or through its APIs. This information can be
changed or modified at will.
■ Source information (source_id, source_name, source_number, and similar
items) are pulled into the Resource Manager from another "source." Information
extracted from a source external to the Resource Manager is not changed by the
Resource Manager or its APIs.
Example sources include:
■ Oracle Human Resources tables
■ Oracle HZ Party tables
Note: The calling application must pass in the resource name to

both p_resource_name and p_source_name. To ensure correct
operation of the API, neither of these values can be NULL.

Procedure Specification
PROCEDURE create_resource
(
p_api_version in number,
p_init_msg_list in varchar2 default fnd_api.g_false,
p_commit in varchar2 default fnd_api.g_false,
p_category in jtf_rs_resource_extns.category%type,
p_source_id in jtf_rs_resource_extns.source_id%type default null,
p_address_id in jtf_rs_resource_extns.address_id%type default null,
p_contact_id in jtf_rs_resource_extns.contact_id%type default null,
p_managing_emp_id in jtf_rs_resource_extns.managing_employee_id%type default null,
p_managing_emp_num in per_employees_current_x.employee_num%type default null,
p_start_date_active in jtf_rs_resource_extns.start_date_active%type,
p_end_date_active in jtf_rs_resource_extns.end_date_active%type default null,
p_time_zone in jtf_rs_resource_extns.time_zone%type default null,
p_cost_per_hr in jtf_rs_resource_extns.cost_per_hr%type default null,
p_primary_language in jtf_rs_resource_extns.primary_language%type default null,
p_secondary_language in jtf_rs_resource_extns.secondary_language%type default null,
p_support_site_id in jtf_rs_resource_extns.support_site_id%type default null,
p_ies_agent_login in jtf_rs_resource_extns.ies_agent_login%type default null,
p_server_group_id in jtf_rs_resource_extns.server_group_id%type default null,
p_interaction_center_name in varchar2 default null,
p_assigned_to_group_id in jtf_rs_resource_extns.assigned_to_group_id%type default null,
p_cost_center in jtf_rs_resource_extns.cost_center%type default null,
p_charge_to_cost_center in jtf_rs_resource_extns.charge_to_cost_center%type default null,
p_comp_currency_code in jtf_rs_resource_extns.compensation_currency_code%type default null,
p_commissionable_flag in jtf_rs_resource_extns.commissionable_flag%type default 'y',
p_hold_reason_code in jtf_rs_resource_extns.hold_reason_code%type default null,
p_hold_payment in jtf_rs_resource_extns.hold_payment%type default 'n',
p_comp_service_team_id in jtf_rs_resource_extns.comp_service_team_id%type default null,
p_user_id in jtf_rs_resource_extns.user_id%type default null,
p_transaction_number in jtf_rs_resource_extns.transaction_number%type default null,
x_return_status out varchar2,
x_msg_count out number,
x_msg_data out varchar2,
x_resource_id out jtf_rs_resource_extns.resource_id%type,
x_resource_number out jtf_rs_resource_extns.resource_number%type,
p_resource_name in jtf_rs_resource_extns_tl.resource_name%type default null,
p_source_name in jtf_rs_resource_extns.source_name%type,
p_source_number in jtf_rs_resource_extns.source_number%type default null,
p_source_job_title in jtf_rs_resource_extns.source_job_title%type default null,
p_source_email in jtf_rs_resource_extns.source_email%type default null,
p_source_phone in jtf_rs_resource_extns.source_phone%type default null,
p_source_org_id in jtf_rs_resource_extns.source_org_id%type default null,
p_source_org_name in jtf_rs_resource_extns.source_org_name%type default null,

p_source_address1 in jtf_rs_resource_extns.source_address1%type default null,

p_source_city in jtf_rs_resource_extns.source_city%type default null,
p_source_postal_code in jtf_rs_resource_extns.source_postal_code%type default null,
p_source_state in jtf_rs_resource_extns.source_state%type default null,
p_source_province in jtf_rs_resource_extns.source_province%type default null,
p_source_county in jtf_rs_resource_extns.source_county%type default null,
p_source_country in jtf_rs_resource_extns.source_country%type default null,
p_source_mgr_id in jtf_rs_resource_extns.source_mgr_id%type default null,
p_source_mgr_name in jtf_rs_resource_extns.source_mgr_name%type default null,
p_source_business_grp_id in jtf_rs_resource_extns.source_business_grp_id%type default null,
p_source_business_grp_name in jtf_rs_resource_extns.source_business_grp_name%type default null,
p_source_first_name in jtf_rs_resource_extns.source_first_name%type default null,
p_source_last_name in jtf_rs_resource_extns.source_last_name%type default null,
p_source_middle_name in jtf_rs_resource_extns.source_middle_name%type default null,
p_source_category in jtf_rs_resource_extns.source_category%type default null,
p_source_status in jtf_rs_resource_extns.source_status%type default null,
p_source_office in jtf_rs_resource_extns.source_office%type default null,
p_source_location in jtf_rs_resource_extns.source_location%type default null,
p_source_mailstop in jtf_rs_resource_extns.source_mailstop%type default null,
p_user_name varchar2,
p_source_mobile_phone in jtf_rs_resource_extns.source_mobile_phone%type default null,
p_source_pager in jtf_rs_resource_extns.source_pager%type default null
);
Current Version
1.0
Parameter Descriptions
The following table describes the IN parameters associated with this API.
Table 2–2 Create_Resource IN Parameters

Descriptions and
Parameter Data Type Required Validations
p_api_version NUMBER Yes See "Standard IN
Parameters" on page 1-3.
p_init_msg_list VARCHAR2 No See "Standard IN


Descriptions and
p_commit VARCHAR2 No See "Standard IN
p_category jtf_rs_resource_extns.category%type Yes Type of resource, valid types
are:
■ EMPLOYEE
■ PARTNER
■ SUPPLIER_CONTACT
■ OTHER
■ PARTY
■ TBH
■ VENUE
p_source_id jtf_rs_resource_extns.resource_id%type No Resource identifier, this
parameter is only used with
the following categories:
■ EMPLOYEE
■ VENUE
■ PARTY
■ SUPPLIER_CONTACT
■ PARTNER
p_address_id jtf_rs_resource_extns.address_id%type No Resource address.
p_contact_id jtf_rs_resource_extns.contact_id%type No Resource contact identifier.
p_managing_emp_id jtf_rs_resource_extns.managing_ No Identifier for the manager of
employee_id%type the resource.
p_managing_emp_num per_employees_current_x.employee_ No Employee number of the
num%type resource’s manager.
p_start_date_active jtf_rs_resource_extns.start_date_ Yes Date on which the resource
active%type becomes active. This value
can not be NULL, and the
start date must be less than
the end date.


Descriptions and
p_end_date_active jtf_rs_resource_extns.end_date_ No Date on which the resource is
active%type no longer active. If no end
date is provided, the resource
is active indefinitely.
p_time_zone jtf_rs_resource_extns. time_zone %type No Time zone, this value must
be a valid time zone as
defined in table HZ_
TIMEZONES.
p_cost_per_hr jtf_rs_resource_extns. cost_per_hr No The salary cost per hour for
%type this resource. This value is
used in conjunction with the
p_comp_currency_code
parameter.
p_primary_language jtf_rs_resource_extns. primary_ No The resource’s primary
language %type language. This value must be
a valid NLS language as
defined in table FND_
LANGUAGES.
p_secondary_language jtf_rs_resource_extns. secondary_ No The resource’s secondary
language %type language. This value must be
a valid NLS language as
defined in table FND_
LANGUAGES.
p_support_site_id jtf_rs_resource_extns.support_site_ No Value used by the Service
id%type applications.
p_ies_agent_login jtf_rs_resource_extns.ies_agent_ No Value used by Interaction
login%type Center applications (if using
Oracle Scripting).
p_server_group_id jtf_rs_resource_extns.server_group_ No Value used by Interaction
id%type Center applications.
p_interaction_center_ VARCHAR2 No Value used by Interaction
name Center applications.
p_assigned_to_group_id jtf_rs_resource_extns.assigned_to_ No The group to which this
group_id%type resource is assigned.
p_cost_center jtf_rs_resource_extns.cost_centere%type No The cost center to which this
resource is assigned.


Descriptions and
p_charge_to_cost_center jtf_rs_resource_extns.charge_to_cost_ No Cost center to charge against,
center%type this may be different than the
resource’s current cost center.
p_comp_currency_code jtf_rs_resource_extns.compensation_ No Compensation currency type,
currency_code this value must be a valid
currency code as listed in
table FND_CURRENCIES.
This value is used in
conjunction with the p_cost_
per_hour parameter.
p_commisionable_flag jtf_rs_resource_extns.commisionable_ No Boolean value:
flag%type
■ Yes - This resource is
eligible for a
commission.
■ No - This resource is not
eligible for a
commission.
The default is Yes.
p_hold_reason_code jtf_rs_resource_extns.hold_reason_ No The reason that
code%type compensation is being
withheld. This value must be
one of the lookup codes for
JTF_RS_HOLD_REASON_
TYPE in table FND_
LOOKUPS.
p_hold_payment jtf_rs_resource_extns.hold_ No Boolean value:
payment%type
■ Yes - Withhold
compensation.
■ No - Do not withhold
compensation.
The default is No.
p_comp_service_team_ jtf_rs_resource_extns.comp_service_ No The identifier for the team to
id team_id%type which this resource belongs.


Descriptions and
p_user_id jtf_rs_resource_extns.user_id%type No Specify this value only if the
following categories are
used:
■ EMPLOYEE
■ PARTY
■ 'SUPPLIER_CONTACT'
If a category other than these
three is specified, the API
exits with an unexpected
error condition.
This value is validated
against table FND_USERS.
p_transaction_number jtf_rs_resource_extns.transaction_ No Transaction identifier
number%type
p_resource_name jtf_rs_resource_extns_tl.resource_ No The calling application must
name%type pass the resource name.
p_source_name jtf_rs_resource_extns.source_ Yes The calling application
name%type passes the source name.
See Resource Information
versus Source Information.
p_source_number jtf_rs_resource_extns.source_ No See Resource Information
number%type versus Source Information.
p_source_job_title jtf_rs_resource_extns.source_job_ No See Resource Information
title%type versus Source Information.
p_source_email jtf_rs_resource_extns.source_ No See Resource Information
email%type versus Source Information.
p_source_phone jtf_rs_resource_extns.source_ No See Resource Information
phone%type versus Source Information.
p_source_org_id jtf_rs_resource_extns.source_org_ No See Resource Information
id%type versus Source Information.
p_source_org_name jtf_rs_resource_extns.source_org_ No See Resource Information
name%type versus Source Information.
p_source_address1 jtf_rs_resource_extns.source_ No See Resource Information
address1%type versus Source Information.


Descriptions and
p_source_city jtf_rs_resource_extns.source_city%type No See Resource Information
p_source_postal_code jtf_rs_resource_extns.source_postal_ No See Resource Information
code%type versus Source Information.
p_source_state jtf_rs_resource_extns.source_state%type No See Resource Information
p_source_province jtf_rs_resource_extns.source_ No See Resource Information
province%type versus Source Information.
p_source_county jtf_rs_resource_extns.source_ No See Resource Information
county%type versus Source Information.
p_source_country jtf_rs_resource_extns.source_ No See Resource Information
country%type versus Source Information.
p_source_mgr_id jtf_rs_resource_extns.source_mgr_ No See Resource Information
p_source_mgr_name jtf_rs_resource_extns.source_mgr_ No See Resource Information
p_source_business_grp_ jtf_rs_resource_extns.source_business_ No See Resource Information
id grp_id%type versus Source Information.
p_source_business_grp_ jtf_rs_resource_extns.source_business_ No See Resource Information
name grp_name%type versus Source Information.
p_source_first_name jtf_rs_resource_extns.source_first_ No See Resource Information
p_source_last_name jtf_rs_resource_extns.source_last_ No See Resource Information
p_source_middle_name jtf_rs_resource_extns.source_middle_ No See Resource Information
p_source_category jtf_rs_resource_extns.source_ No See Resource Information
category%type versus Source Information.


Descriptions and
p_source_status jtf_rs_resource_extns.source_ No See Resource Information
status%type versus Source Information.
p_source_office jtf_rs_resource_extns.source_ No See Resource Information
office%type versus Source Information.
p_source_location jtf_rs_resource_extns.source_ No See Resource Information
location%type versus Source Information.
p_source_mailstop jtf_rs_resource_extns.source_ No See Resource Information
mailstop%type versus Source Information.
p_user_name VARCHAR2 Yes The identifier of the person
entering values into the
source.
p_source_mobile_phone jtf_rs_resource_extns.source_mobile_ No See Resource Information
p_source_pager jtf_rs_resource_extns.source_ No See Resource Information
pager%type versus Source Information.
The following table describes the OUT parameters associated with this API.
Table 2–3 Create_Resource OUT Parameters

Parameter Data type Description
x_return_status VARCHAR2 See "Standard OUT Parameters" on page 1-4.
x_msg_count NUMBER See "Standard OUT Parameters" on page 1-4.
x_msg_data VARCHAR2 See "Standard OUT Parameters" on page 1-4.
x_resource_id jtf_rs_resource_extns. resource_id The automatically generated resource identifier
%type that is created through an internal call to JTF_RS_
RESOURCE_EXTNS_S.
x_resource_ jtf_rs_resource_extns. resource_ The automatically generated resource number that
number number %type is created through an internal call to JTF_RS_
RESOURCE_NUMBER_S.
2.2.2 Update_Resource
The Update_Resource API updates resource attributes such as Resource Name, Start
Date, End Date, and User ID. Before updating these attributes, the API first verifies

that the resource exists in the Resources table. The Update_Resource API updates
resource information in the Call Center, Compensation, and the Account
Receivables tables.
PROCEDURE update_resource
(
p_resource_id in jtf_rs_resource_extns.resource_id%type,
p_resource_number in jtf_rs_resource_extns.resource_number%type,
p_managing_emp_id in jtf_rs_resource_extns.managing_employee_id%type default fnd_api.g_miss_num,
p_start_date_active in jtf_rs_resource_extns.start_date_active%type default fnd_api.g_miss_date,
p_end_date_active in jtf_rs_resource_extns.end_date_active%type default fnd_api.g_miss_date,
p_time_zone in jtf_rs_resource_extns.time_zone%type default fnd_api.g_miss_num,
p_cost_per_hr in jtf_rs_resource_extns.cost_per_hr%type default fnd_api.g_miss_num,
p_primary_language in jtf_rs_resource_extns.primary_language%type default fnd_api.g_miss_char,
p_secondary_language in jtf_rs_resource_extns.secondary_language%type default fnd_api.g_miss_char,
p_support_site_id in jtf_rs_resource_extns.support_site_id%type default fnd_api.g_miss_num,
p_ies_agent_login in jtf_rs_resource_extns.ies_agent_login%type default fnd_api.g_miss_char,
p_server_group_id in jtf_rs_resource_extns.server_group_id%type default fnd_api.g_miss_num,
p_assigned_to_group_id in jtf_rs_resource_extns.assigned_to_group_id%type default fnd_api.g_miss_num,
p_cost_center in jtf_rs_resource_extns.cost_center%type default fnd_api.g_miss_char,
p_charge_to_cost_center in jtf_rs_resource_extns.charge_to_cost_center%type default fnd_api.g_miss_char,
p_comp_currency_code in jtf_rs_resource_extns.compensation_currency_code%type
default fnd_api.g_miss_char,
p_commissionable_flag in jtf_rs_resource_extns.commissionable_flag%type default fnd_api.g_miss_char,
p_hold_reason_code in jtf_rs_resource_extns.hold_reason_code%type default fnd_api.g_miss_char,
p_hold_payment in jtf_rs_resource_extns.hold_payment%type default fnd_api.g_miss_char,
p_comp_service_team_id in jtf_rs_resource_extns.comp_service_team_id%type default fnd_api.g_miss_num,
p_user_id in jtf_rs_resource_extns.user_id%type default fnd_api.g_miss_num,
p_resource_name in jtf_rs_resource_extns_tl.resource_name%type default fnd_api.g_miss_char
p_source_name in jtf_rs_resource_extns.source_name%type,
p_source_number in jtf_rs_resource_extns.source_number%type default fnd_api.g_miss_char,
p_source_job_title in jtf_rs_resource_extns.source_job_title%type default fnd_api.g_miss_char,
p_source_email in jtf_rs_resource_extns.source_email%type default fnd_api.g_miss_char,
p_source_phone in jtf_rs_resource_extns.source_phone%type default fnd_api.g_miss_char,
p_source_org_id in number default fnd_api.g_miss_num,
p_source_org_name in jtf_rs_resource_extns.source_org_name%type default fnd_api.g_miss_char,
p_source_address1 in jtf_rs_resource_extns.source_address1%type default fnd_api.g_miss_char,
p_source_city in jtf_rs_resource_extns.source_city%type default fnd_api.g_miss_char,
p_source_postal_code in jtf_rs_resource_extns.source_postal_code%type default fnd_api.g_miss_char,
p_source_state in jtf_rs_resource_extns.source_state%type default fnd_api.g_miss_char,
p_source_province in jtf_rs_resource_extns.source_province%type default fnd_api.g_miss_char,

p_source_county in jtf_rs_resource_extns.source_county%type default fnd_api.g_miss_char,

p_source_country in jtf_rs_resource_extns.source_country%type default fnd_api.g_miss_char,
p_source_mgr_id in jtf_rs_resource_extns.source_mgr_id%type default fnd_api.g_miss_num,
p_source_mgr_name in jtf_rs_resource_extns.source_mgr_name%type default fnd_api.g_miss_char,
p_source_business_grp_id in jtf_rs_resource_extns.source_business_grp_id%type
default fnd_api.g_miss_num,
p_source_business_grp_name in jtf_rs_resource_extns.source_business_grp_name%type
default fnd_api.g_miss_char,
p_source_first_name in jtf_rs_resource_extns.source_first_name%type default fnd_api.g_miss_char,
p_source_last_name in jtf_rs_resource_extns.source_last_name%type default fnd_api.g_miss_char,
p_source_middle_name in jtf_rs_resource_extns.source_middle_name%type default fnd_api.g_miss_char,
p_source_category in jtf_rs_resource_extns.source_category%type default fnd_api.g_miss_char,
p_source_status in jtf_rs_resource_extns.source_status%type default fnd_api.g_miss_char,
p_source_office in jtf_rs_resource_extns.source_office%type default fnd_api.g_miss_char,
p_source_location in jtf_rs_resource_extns.source_location%type default fnd_api.g_miss_char,
p_source_mailstop in jtf_rs_resource_extns.source_mailstop%type default fnd_api.g_miss_char,
p_address_id in jtf_rs_resource_extns.address_id%type default fnd_api.g_miss_num,
p_object_version_num in out jtf_rs_resource_extns.object_version_number%type,
p_user_name in varchar2 default fnd_api.g_miss_char,
p_source_mobile_phone in jtf_rs_resource_extns.source_mobile_phone%type default null,
p_source_pager in jtf_rs_resource_extns.source_pager%type default null
);
Current Version
1.0
Table 2–4 Update_Resource IN Parameters

Parameter Data Type Required Descriptions and Validations
p_api_version NUMBER Yes See "Standard IN Parameters"
on page 1-3.
p_init_msg_list VARCHAR2 No See "Standard IN Parameters"
on page 1-3.
p_commit VARCHAR2 No See "Standard IN Parameters"
on page 1-3.


p_resource_id jtf_rs_resource_extns. resource_id Yes This value is created through
%type an internal call in the Create_
Resource API.
The reference identifier is
validated for existence in JTF_
RS_RESOURCE_EXTNS.
p_resource_number jtf_rs_resource_extns.resource_ Yes This value is created through
number%type an internal call in the Create_
Resource API.
The reference number is
RS_RESOURCE_EXTNS.
p_managing_emp_id jtf_rs_resource_extns.managing_ No Identifier for the manager of
employee_id%type the resource.
p_managing_emp_ per_employees_current_x.employee_ No Employee number of the
num num%type resource’s manager.
p_start_date_active jtf_rs_resource_extns.start_date_ No Date on which the resource
active%type becomes active. This value can
not be NULL, and the start
date must be less than the end
date.
p_end_date_active jtf_rs_resource_extns.end_date_ No Date on which the resource is
active%type no longer active. If no end date
is provided, the resource is
active indefinitely.
p_time_zone jtf_rs_resource_extns. time_zone %type No Time zone, this value must be
a valid time zone as defined in
table HZ_TIMEZONES.
p_cost_per_hr jtf_rs_resource_extns. cost_per_hr No The salary cost per hour for
%type this resource.
p_primary_language jtf_rs_resource_extns. primary_ No The resource’s primary
language %type language. This value must be a
valid NLS language as defined
in table FND_LANGUAGES.
p_secondary_language jtf_rs_resource_extns. secondary_ No The resource’s secondary
language %type language. This value must be a
valid NLS language as defined
in table FND_LANGUAGES.


p_support_site_id jtf_rs_resource_extns.support_site_ No Value used by Service
id%type applications.
p_ies_agent_login jtf_rs_resource_extns.ies_agent_ No Value used by Interaction
login%type Center applications (if using
Oracle Scripting).
p_server_group_id jtf_rs_resource_extns.server_group_ No Value used by Interaction
id%type Center applications.
p_assigned_to_group_ jtf_rs_resource_extns.assigned_to_ No The group to which this
id group_id%type resource is assigned.
p_cost_center jtf_rs_resource_extns.cost_centere%type No The cost center to which this
resource is assigned.
p_charge_to_cost_ jtf_rs_resource_extns.charge_to_cost_ No Cost center to charge against,
center center%type this may be different than the
resources current cost center.
p_comp_currency_ jtf_rs_resource_extns.compensation_ No Compensation currency type,
code currency_code this value must be a valid
currency code as listed in view
FND_CURRENCIES_
ACTIVE_MONET_V (from
table FND_CURRENCIES).
p_commisionable_flag jtf_rs_resource_extns.commisionable_ No Boolean value:
flag%type
■ Yes - This resource is
eligible for a commission.
■ No - This resource is not
eligible for a commission.
The default is Yes.
p_hold_reason_code jtf_rs_resource_extns.hold_reason_ No The reason that compensation
code%type is being withheld. This value
must be one of the lookup
codes for JTF_RS_HOLD_
REASON_TYPE in table FND_
LOOKUPS.


p_hold_payment jtf_rs_resource_extns.hold_ No Boolean value:
payment%type
■ Yes - Withhold
compensation.
■ No - Do not withhold
compensation.
The default is No.
p_comp_service_team_ jtf_rs_resource_extns.comp_service_ No The identifier for the team to
id team_id%type which this resource belongs.
p_user_id jtf_rs_resource_extns.user_id%type No Specify this value only if the
following categories are used:
■ EMPLOYEE
■ PARTY
■ 'SUPPLIER_CONTACT'
If a category other than these
three is specified, the API exits
with an unexpected error
condition.
This value is validated against
table FND_USERS.
p_resource_name jtf_rs_resource_extns_tl.resource_ No The calling application must
name%type pass the resource name. This
value can not be NULL.
p_source_name jtf_rs_resource_extns.source_ Yes The calling application must
name%type pass the resource name. This
value can not be NULL.
See Resource Information
p_source_number jtf_rs_resource_extns.source_ No See Resource Information
number%type versus Source Information.
p_source_job_title jtf_rs_resource_extns.source_job_ No See Resource Information
title%type versus Source Information.
p_source_email jtf_rs_resource_extns.source_ No See Resource Information
email%type versus Source Information.
p_source_phone jtf_rs_resource_extns.source_ No See Resource Information


p_source_org_id jtf_rs_resource_extns.source_org_ No See Resource Information
p_source_org_name jtf_rs_resource_extns.source_org_ No See Resource Information
p_source_city jtf_rs_resource_extns.source_city%type No See Resource Information
p_source_postal_code jtf_rs_resource_extns.source_postal_ No See Resource Information
code%type versus Source Information.
p_source_state jtf_rs_resource_extns.source_state%type No See Resource Information
p_source_province jtf_rs_resource_extns.source_ No See Resource Information
province%type versus Source Information.
p_source_county jtf_rs_resource_extns.source_ No See Resource Information
county%type versus Source Information.
p_source_country jtf_rs_resource_extns.source_ No See Resource Information
country%type versus Source Information.
p_source_mgr_id jtf_rs_resource_extns.source_mgr_ No See Resource Information
p_source_mgr_name jtf_rs_resource_extns.source_mgr_ No See Resource Information
p_source_business_ jtf_rs_resource_extns.source_business_ No See Resource Information
grp_id grp_id%type versus Source Information.
p_source_business_ jtf_rs_resource_extns.source_business_ No See Resource Information
grp_name grp_name%type versus Source Information.
p_source_first_name jtf_rs_resource_extns.source_first_ No See Resource Information


p_source_last_name jtf_rs_resource_extns.source_last_ No See Resource Information
p_source_middle_ jtf_rs_resource_extns.source_middle_ No See Resource Information
name name%type versus Source Information.
p_source_category jtf_rs_resource_extns.source_ No See Resource Information
category%type versus Source Information.
p_source_status jtf_rs_resource_extns.source_ No See Resource Information
status%type versus Source Information.
p_source_office jtf_rs_resource_extns.source_ No See Resource Information
office%type versus Source Information.
p_source_location jtf_rs_resource_extns.source_ No See Resource Information
location%type versus Source Information.
p_source_mailstop jtf_rs_resource_extns.source_ No See Resource Information
mailstop%type versus Source Information.
p_address_id jtf_rs_resource_extns.address_id%type No See Resource Information
p_object_version_num jtf_rs_resource_extns.object_version_ Yes The object version number of
number%type, the resource ID derives from
the jtf_rs_resource_extns table.
p_user_name VARCHAR2 No The name of the person
entering values into the
source.
p_source_mobile_ jtf_rs_resource_extns.source_mobile_ No See Resource Information
phone phone%type versus Source Information.
p_source_pager jtf_rs_resource_extns.source_ No See Resource Information
pager%type versus Source Information.
Table 2–5 Update_Resource OUT Parameters

Parameter Data Type Descriptions

2.3 Package JTF_RS_GROUPS_PUB

■ Create_Resource_Group
■ Update_Resource_Group
2.3.1 Create_Resource_Group
The Create_Resource Group API creates a Resource Group and generates the group_id
number.
PROCEDURE create_resource_group
(
p_group_name in jtf_rs_groups_vl.group_name%type,
p_group_desc in jtf_rs_groups_vl.group_desc%type default null,
p_exclusive_flag in jtf_rs_groups_vl.exclusive_flag%type default 'n',
p_email_address in jtf_rs_groups_vl.email_address%type default null,
p_start_date_active in jtf_rs_groups_vl.start_date_active%type,
p_end_date_active in jtf_rs_groups_vl.end_date_active%type default null,
p_accounting_code in jtf_rs_groups_vl.accounting_code%type default null,
x_group_id out jtf_rs_groups_vl.group_id%type,
x_group_number out jtf_rs_groups_vl.group_number%type
);
Current Version
1.0

Table 2–6 Create_Resource_Group IN Parameters

on page 1-3.
on page 1-3.
on page 1-3.
p_group_name jtf_rs_groups_vl.group_name%type Yes The name of the resource
group.
p_group_desc jtf_rs_groups_vl.group_desc%type No A description of the resource
group.
p_exclusive_flag jtf_rs_groups_vl. exclusive_flag%type No Boolean value:
■ Yes - Assign resources
only to this group with a
particular member role
and group usage that is
not assigned to any other
exclusive group with the
same role and usage in the
same time frame.
■ No - Disable this feature.
If p_exclusive_flag is set to
yes, then you can assign
resources only to this group
with a particular member role
and group usage that is not
assigned to any other exclusive
group with the same role and
usage in the same time frame.
Because you specify the
resource in this group
exclusively, the same resource
with the same member roles
cannot be assigned to another
group during the overlapping
time frame.

Table 2–6 Create_Resource_Group IN Parameters

p_email_address jtf_rs_groups_vl. email_address%type No The email address of the group
owner.
p_start_date_active jtf_rs_groups_vl.start_date_active%type Yes Date on which the resource
group becomes active. This
value can not be NULL, and
the start date must be less than
the end date.
p_end_date_active jtf_rs_groups_vl. end_date_active%type No Date on which the resource
group is no longer active. If no
end date is provided, the
group is active indefinitely.
p_accounting_code jtf_rs_groups_vl. accounting_ No Account code, for internal use
code%type only.
Table 2–7 Create_Resource OUT Parameters

x_group_id jtf_rs_groups_vl.group_id%type, The automatically generated group identifier
that is created through an internal call to JTF_
RS_GROUPS_S.
x_group_number jtf_rs_groups_vl.group_ The automatically generated group number that
number%type is created through an internal call to JTF_RS_
GROUP_NUMBER_S.
2.3.2 Update_Resource_Group
The Update_Resource API updates resource group attributes such as Group Name,
Group Description, Start and End Date effectively.
PROCEDURE update_resource_group
(

p_group_id in jtf_rs_groups_vl.group_id%type,
p_group_number in jtf_rs_groups_vl.group_number%type,
p_group_name in jtf_rs_groups_vl.group_name%type default fnd_api.g_miss_char,
p_group_desc in jtf_rs_groups_vl.group_desc%type default fnd_api.g_miss_char,
p_exclusive_flag in jtf_rs_groups_vl.exclusive_flag%type default fnd_api.g_miss_char,
p_email_address in jtf_rs_groups_vl.email_address%type default fnd_api.g_miss_char,
p_start_date_active in jtf_rs_groups_vl.start_date_active%type default fnd_api.g_miss_date,
p_end_date_active in jtf_rs_groups_vl.end_date_active%type default fnd_api.g_miss_date,
p_accounting_code in jtf_rs_groups_vl.accounting_code%type default fnd_api.g_miss_char,
p_object_version_num in out jtf_rs_groups_vl.object_version_number%type,
x_msg_data out varchar2
);
Current Version
1.0
Table 2–8 Update_Resource_Group IN Parameters

on page 1-3.
on page 1-3.
on page 1-3.
p_group_id jtf_rs_groups_vl. group_id%type Yes The value is created through
an internal call in the Create_
Resource API.
This parameter is validated for
existence in table JTF_RS_
GROUPS_B.
p_group_number jtf_rs_groups. group_id%type No The value is created through
Resource API.


p_group_name jtf_rs_groups_vl. group_name%type Yes The name of the resource
group.
p_group_desc jtf_rs_groups_vl. group_desc%type No A description of the resource
group.
p_exclusive_flag jtf_rs_groups_vl. exclusive_flag%type No Boolean value:
■ Yes - Assign resources
only to this group with a
particular member role
and group usage that is
not assigned to any other
exclusive group with the
same role and usage in the
same time frame.
■ No - Disable this feature.
If p_exclusive_flag is set to
yes, then you can assign
resources only to this group
with a particular member role
and group usage that is not
assigned to any other exclusive
group with the same role and
usage in the same time frame.
Because you specify the
resource in this group
exclusively, the same resource
with the same member roles
cannot be assigned to another
group during the overlapping
time frame.
The default is No.
p_email_address jtf_rs_groups_vl. email_address%type No The email address of the group
owner.
p_start_date_active jtf_rs_groups_vl. start_date_ Yes Date on which the resource
active%type group becomes active. This
value can not be NULL, and
the start date must be less than
the end date.


p_end_date_active jtf_rs_groups_vl. end_date_active%type No Date on which the resource
group is no longer active. If no
end date is provided, the
resource is active indefinitely.
p_accounting_code jtf_rs_groups_vl. accounting_ No Account Code, for internal use
code%type only.
p_object_version_num jtf_rs_groups_vl.object_version_ Yes The object version number of
number%type the group ID derives from the
jtf_rs_groups_extns table.
Table 2–9 Update_Resource_Group OUT Parameters

2.4 Package JTF_RS_SALESREPS_PUB

■ Create_SalesRep
■ Update_SalesRep
2.4.1 Create_SalesRep
The Create_SalesRep API creates a resource of type Salesrep. The API verifies the resource ID
parameter from the JTF_RS_RESOURC_.EXTNS table which is created using the
Create_Resource API.

2.4.1.1 Setting the org_context

When using a script to call the the Create_Salesrep API, the following commands
must be used to properly set the org_context:
mo_global.set_org_context(999, NULL);
where 999 is the org_id parameter value to which the context is set. This should be
done every time you call the Create_Salesrep API.
PROCEDURE create_salesrep
(
p_resource_id in jtf_rs_salesreps.resource_id%type,
p_sales_credit_type_id in jtf_rs_salesreps.sales_credit_type_id%type,
p_name in jtf_rs_salesreps.name%type default null,
p_status in jtf_rs_salesreps.status%type default null,
p_start_date_active in jtf_rs_salesreps.start_date_active%type default null,
p_end_date_active in jtf_rs_salesreps.end_date_active%type default sysdate,
p_gl_id_rev in jtf_rs_salesreps.gl_id_rev%type default null,
p_gl_id_freight in jtf_rs_salesreps.gl_id_freight%type default null,
p_gl_id_rec in jtf_rs_salesreps.gl_id_rec%type default null,
p_set_of_books_id in jtf_rs_salesreps.set_of_books_id%type default null,
p_salesrep_number in jtf_rs_salesreps.salesrep_number%type default null,
p_email_address in jtf_rs_salesreps.email_address%type default null,
p_wh_update_date in jtf_rs_salesreps.wh_update_date%type default null,
p_sales_tax_geocode in jtf_rs_salesreps.sales_tax_geocode%type default null,
p_sales_tax_inside_city_limits in jtf_rs_salesreps.sales_tax_inside_city_limits%type
default null,
x_salesrep_id out jtf_rs_salesreps.salesrep_id%type
);
Current Version
1.0

Table 2–10 Create_SalesRep IN Parameters

on page 1-3.
on page 1-3.
on page 1-3.
p_resource_id jtf_rs_salesreps. resource_id%type Yes This value is created through
Resource API.
The reference identifier is
RS_RESOURCE_EXTNS.
p_sales_credit_type_id jtf_rs_salesreps. sales_credit_type_ Yes This value is validated against
id%type table OE_SALES_CREDIT_
TYPES.
p_name jtf_rs_salesreps.name%type No The sales person’s name.
p_status jtf_rs_salesreps. status%type No The status of this salesperson.
For example, this could be set
to Active.
p_start_date_active jtf_rs_salesreps. start_date_active%type No Date on which the salesperson
becomes active. This value can
date.
p_end_date_active jtf_rs_salesreps. end_date_active%type No The effective end date for the
salespersons. If no end date is
provided, the salesperson is
p_gl_id_rev jtf_rs_salesreps.gl_id_rev%type No Accounting flexfield used for
Revenue accounts.
This value is used by Oracle
Accounts Receivables only to
determine the revenue
accounts for invoices assigned
to this salesperson.

Table 2–10 Create_SalesRep IN Parameters

p_gl_id_freight jtf_rs_salesreps.gl_id_frieght%type No Accounting flexfield used for
Freight accounts.
determine the freight accounts
for invoices assigned to this
salesperson.
p_gl_id_rec jtf_rs_salesreps.gl_id_rec%type No Accounting flexfield used for
Receivables accounts.
determine the receivable
p_set_of_books_id jtf_rs_salesreps.set_of_books_id%type No Set of books identifier, used by
Oracle Accounts Receivables.
p_salesrep_number jtf_rs_salesreps.salesrep_number%type No This typical alphanumeric
designation is user generated.
p_email_address jtf_rs_salesreps.email_address%type No Email address of the
salesperson.
p_wh_update_date jtf_rs_salesreps.wh_update_date%type No This date is sent to the data
warehouse.
This parameter is used for
backwards compatibility with
Oracle Accounts Receivables
and is written to table RA_
SALESREPS_ALL.
p_sales_tax_geocode jtf_rs_salesreps.sales_tax_ No Sales tax code, it associates the
geocode%type salesperson with a unique tax
jurisdiction.
Use only if a sales tax vendor
is also installed.
p_sales_tax_inside_ jtf_rs_salesreps.sales_tax_inside_city_ No Indicates that the tax
city_limits limits%type jurisdiction for this address is
within city limits.
Use only if a value for p_sales_
tax_geocode is supplied.

Table 2–11 Create_SalesRep OUT Parameters

x_return_status VARCHAR2 See "Standard OUT Parameters" on
page 1-4.
x_msg_count NUMBER See "Standard OUT Parameters" on
page 1-4.
x_msg_data VARCHAR2 See "Standard OUT Parameters" on
page 1-4.
x_salesrep_id jtf_rs_salesrep.salesrep_id%type The automatically generated salesperson
identifier that is created through an
internal call to JTF_RS_SALESREPS_S.
2.4.2 Update_SalesRep
The Update_SalesRep API updates SalesRep attributes such as Salesperson
Number, Sales Credit Type, Start and End Date.
2.4.2.1 Setting the org_context

When using a script to call the the Update_Salesrep API, the following commands
must be used to properly set the org_context:
mo_global.set_org_context(999, NULL);
where 999 is the org_id parameter value to which the context is set. This should be
done every time you call the Update_Salesrep API.
PROCEDURE update_salesrep
(
p_init_msg_list in varchar2 default fnd_api.g_ false,
p_salesrep_id in jtf_rs_salesreps.salesrep_id%type,
p_sales_credit_type_id in jtf_rs_salesreps.sales_credit_type_id%type,
p_name in jtf_rs_salesreps.name%type default fnd_api.g_miss_char,
p_status in jtf_rs_salesreps.status%type default fnd_api.g_miss_char,
p_start_date_active in jtf_rs_salesreps.start_date_active%typ default fnd_api.g_miss_date,
p_end_date_active in jtf_rs_salesreps.end_date_active%type default fnd_api.g_miss_date,
p_gl_id_rev in jtf_rs_salesreps.gl_id_rev%type default fnd_api.g_miss_num,
p_gl_id_freight in jtf_rs_salesreps.gl_id_freight%type default fnd_api.g_miss_num,

p_gl_id_rec in jtf_rs_salesreps.gl_id_rec%type default fnd_api.g_miss_num,

p_set_of_books_id in jtf_rs_salesreps.set_of_books_id%type default fnd_api.g_miss_num,
p_salesrep_number in jtf_rs_salesreps.salesrep_number%type default fnd_api.g_miss_char,
p_email_address in jtf_rs_salesreps.email_address%type default fnd_api.g_miss_char,
p_wh_update_date in jtf_rs_salesreps.wh_update_date%type default fnd_api.g_miss_date,
p_sales_tax_geocode in jtf_rs_salesreps.sales_tax_geocode%type default fnd_api.g_miss_char,
p_sales_tax_inside_city_limits in jtf_rs_salesreps.sales_tax_inside_city_limits%type default fnd_api.g_
miss_char,
p_org_id in jtf_rs_salesreps.org_id%type,
p_object_version_number in out jtf_rs_salesreps.object_version_number%type,
);
Current Version
1.0
Table 2–12 Update_SalesRep IN Parameters

on page 1-3.
on page 1-3.
on page 1-3.
p_salesrep_id jtf_rs_salesreps. salesrep_id%type Yes This value is created through
SalesRep API.
If a valid value is not supplied,
the API exits with an
unexpected error condition.
p_sales_credit_type_id jtf_rs_salesreps.sales_credit_type_ Yes This value is validated against
id%type table OE_SALES_CREDIT_
TYPES.
p_name jtf_rs_salesreps.name%type No The sales person’s name.


p_status jtf_rs_salesreps.status%type No The status of this salesperson.
For example, this could be set
to Active.
p_start_date_active jtf_rs_slaesreps.start_date_active%type No Date on which the salesperson
becomes active. This value can
date.
p_end_date_active jtf_rs_salesreps. end_date_active%type No The effective end date for the
salesperson. If no end date is
provided, the salesperson is
p_gl_id_rev jtf_rs_salesreps.gl_id_freight%type No Accounting flexfield used for
Revenue accounts.
determine the revenue
p_gl_id_freight jtf_rs_salesreps.gl_id_freight%type No Accounting flexfield used for
Freight accounts.
determine the freight accounts
for invoices assigned to this
salesperson.
p_gl_id_rec jtf_rs_salesreps.gl_id_rec%type No Accounting flexfield used for
Receivables accounts.
determine the receivable
p_set_of_books_id jtf_rs_salesreps.set_of_books_id%type No Parameter used by Oracle
Accounts Receivables.
p_salesrep_number jtf_rs_salesreps.salesrep_number%type No This typical alphanumeric
designation is user generated.
p_email_address jtf_rs_salesreps.email_address%type No Email address of the
salesperson.


p_wh_update_date jtf_rs_salesreps.wh_update_date%type No This date is sent to the data
warehouse.
This parameter is used for
backwards compatibility with
Oracle Accounts Receivables
and is written to table RS_
SALESREPS_ALL.
p_sales_tax_geocode jtf_rs_salesreps.sales_tax_ No Sales tax code, it associates the
geocode%type salesperson with a unique tax
jurisdiction.
Use only if a sales tax vendor
is also installed.
p_sales_tax_inside_ jtf_rs_salesreps.sales_tax_inside_city_ No Indicates that the tax
city_limits limits%type jurisdiction for this address is
within city limits.
Use only if a value for p_sales_
tax_geocode is supplied.
p_org_id jtf_rs_salesreps.org_id%type Yes Organization Identifier
p_object_version_ jtf_rs_salesreps.object_version_ Yes The object version number of
number number%type the salesrep ID derives from
the JTF_RS_SALESREPS table.
Table 2–13 Update_SalesRep OUT Parameters

Parameter Data Type Descriptions and Validations

Messages and Notifications
2.5 Messages and Notifications

The APIs contained in the Resource Manager public packages generate messages
and notifications as needed. These messages are detailed in the following sections.
■ JTF_RS_RESOURCE_PUB
■ JTF_RS_GROUPS_PUB

it is provided.
2.5.1 JTF_RS_RESOURCE_PUB
This section describes the messages and notifications generated by the APIs
contained in the JTF_RS_RESOURCE_PUB package.
2.5.1.1 Create_Resource
The following table lists the messages and notifications generated by the Create_
Resource API.
Table 2–14 Create_Resource Messages

Number Type Name Text
210209 E JTF_RS_INVALID_EMP_RESOURCE_ Employee Resource ID &P_EMP_RESOURCE_
ID ID is not Valid or the Resource is Inactive.
210211 E JTF_RS_RESOURCE_CATEGORY_ Resource Category should not be NULL.
NULL
210212 E JTF_RS_INVALID_RES_CATEGORY Resource Category &P_RESOURCE_
CATEGORY is not Valid.
210213 E JTF_RS_TIME_ZONE_NULL Time Zone is Null.
210214 E JTF_RS_INVALID_TIME_ZONE Time Zone ID &P_TIME_ZONE_ID is not Valid.
210215 E JTF_RS_LANGUAGE_NULL Language is Null.
210216 E JTF_RS_INVALID_LANGUAGE NLS Language &P_LANGUAGE is not Valid.
210224 U JTF_RS_SOURCE_ID_NULL Source Identifier should not be NULL.


210328 U JTF_RS_USERID_ERROR For the specified Category, User ID should be
NULL.
210229 U JTF_RS_EMP_IDS_NOT_NULL For Resource Category EMPLOYEE address_id
and contact_id should be NULL.
210230 U JTF_RS_ERR_ASSIGN_TO_GRP_ID Assigned To Group ID, p_assigned_to_group_id
is not Valid.
210231 U JTF_RS_INVALID_FLAG_VALUE Flag value should either be "Y" or "N."
210235 E JTF_RS_SUPPORT_SITE_NULL Support Site should Not be Null.
210236 E JTF_RS_INVALID_SUPPORT_SITE Support Site &P_SUPPORT_SITE is Not Valid.
210237 E JTF_RS_INVALID_SRV_GROUP_ID Server Group ID &P_SERVER_GROUP_ID is
Not Valid.
210238 E JTF_RS_INVALID_SVR_GROUP_ Interaction Center Name &P_SERVER_GROUP_
NAME NAME is Not Valid.
210239 E JTF_RS_CURRENCY_NULL Currency Code should Not be Null.
210240 E JTF_RS_INVALID_CURRENCY Currency Code &P_CURRENCY is Not Valid.
210241 E JTF_RS_HOLD_REASON_CODE_ Hold Reason Code should Not be Null.
NULL
210242 E JTF_RS_INVALID_HOLD_REASON_ Hold Reason Code &P_HOLD_REASON_CODE
COD is Not Valid.
210243 E JTF_RS_TEAM_NULL Team ID and Team Number are Null.
210244 E JTF_RS_INVALID_TEAM Team ID &P_TEAM_ID is Not Valid.
210245 E JTF_RS_INVALID_TEAM_NUMBER Team Number &P_TEAM_NUMBER is Not
Valid.
210259 E JTF_RS_USER_ID_NULL User ID cannot be Null.
210260 E JTF_RS_INVALID_USER_ID User ID &P_USER_ID is Not Valid.
210340 U JTF_RS_INVALID_RL_RES_TYPE Role Resource Type does not exist in JTF Objects.
210346 U JTF_RS_INVALID_OBJ_USER_CODE Invalid Object User code.
210393 U JTF_RS_UNEXP_ERROR An unexpected error was encountered in &P_
API_NAME.
210218 E JTF_RS_TABLE_HANDLER_ERROR Error in the Table Handler.


210265 E JTF_RS_ERR_POST_CUST_USR_ Returned Error status from the Post Customer
HOOK User Hook.
210266 E JTF_RS_ERR_POST_VERT_USR_ Returned Error status from the Post Vertical User
HOOK Hook.
210327 E JTF_RS_ERR_POST_INT_USR_HOOK Returned Error status from the Post Internal
User Hook.
210267 E JTF_RS_ERR_MESG_GENERATE_API Returned Error status from the Message
Generation API.
210393 E JTF_RS_UNEXP_ERROR Program Error: An unexpected error was
encountered in &P_API_NAME.
210207 U JTF_RS_RESOURCE_NULL Resource identifier and Resource Number are
NULL.
210219 U JTF_RS_START_DATE_NULL Start Date Active cannot be NULL.
210220 U JTF_RS_OTHER_IDS_NOT_NULL For Resource Category OTHER/TBH the Source
identifier, Address identifier, Contact identifier,
and Managing Emp identifier should be NULL.
210221 U JTF_RS_PARTNER_IDS_NULL For Resource Category PARTNER the Source_id
should not be NULL.
210222 U JTF_RS_INVALID_PARTNER_IDS Partner does not exist for the passed Source_id.
210223 U JTF_RS_ERR_PARTNER_CONTACT_ Partner contact id p_contact_id is not valid.
ID
210225 U JTF_RS_INVALID_SOURCE_ID Source identifier p_source_id is not valid.
210226 U JTF_RS_INVALID_PARTY_ADDRESS Party Address identifier <Address_id> is Not
Valid.
210227 U JTF_RS_ERR_PARTY_CONTACT_ID Party Contact identifier <Contact_id> is Not
Valid.
210228 U JTF_RS_SC_IDS_NOT_NULL For Resource Category SUPPLIER_CONTACT
Address_id and Contact_id should be NULL.
210374 U JTF_RS_ERR_DUPLICATE_USER_ID The user identifier <User_id> already exist.
380060 E JTF_RS_NOT_PRIMARY_ADDR The address ID passed in is not the primary
address of the PARTY/PARTNER.
210383 U JTF_RS_ERR_PARTNER_ADDRESS_ID Partner address identifier p_address_id is not
valid.

2.5.1.2 Update_Resource
The following table lists the messages and notifications generated by the Update_
Resource API.
Table 2–15 Update_Resource Messages

210204 U JTF_RS_INVALID_RESOURCE Resource identifier <Resource_id> is not valid or
is inactive.
210208 U JTF_RS_INVALID_RESOURCE_ Resource Number <Resource_number> is not
NUMBER valid or the resource is inactive.
210209 E JTF_RS_INVALID_EMP_RESOURCE_ Employee Resource ID &P_EMP_RESOURCE_
ID ID is not Valid or the Resource is Inactive.
210213 E JTF_RS_TIME_ZONE_NULL Time Zone is Null.
210214 E JTF_RS_INVALID_TIME_ZONE Time Zone ID &P_TIME_ZONE_ID is not Valid.
210215 E JTF_RS_LANGUAGE_NULL Language is Null.
210216 E JTF_RS_INVALID_LANGUAGE NLS Language &P_LANGUAGE is not Valid.
210218 U JTF_RS_TABLE_HANDLER_ERROR Error in the Table Handler.
User Hook.
210230 U JTF_RS_ERR_ASSIGN_TO_GRP_ID Assigned To Group identifier <Assigned_to_
group_id> is not valid.
210231 U JTF_RS_INVALID_FLAG_VALUE Flag value should either be "Y" or "N."
210232 E JTF_RS_ERR_STDT_GREATER_EDDT Start Date Active cannot be greater than the End
Date Active.
210236 E JTF_RS_INVALID_SUPPORT_SITE Support Site &P_SUPPORT_SITE is Not Valid.
210237 E JTF_RS_INVALID_SRV_GROUP_ID Server Group ID &P_SERVER_GROUP_ID is
Not Valid.
210238 E JTF_RS_INVALID_SVR_GROUP_ Interaction Center Name &P_SERVER_GROUP_
NAME NAME is Not Valid.
210239 E JTF_RS_CURRENCY_NULL Currency Code should Not be Null.
210240 E JTF_RS_INVALID_CURRENCY Currency Code &P_CURRENCY is Not Valid.
210241 E JTF_RS_HOLD_REASON_CODE_ Hold Reason Code should Not be Null.
NULL


210242 E JTF_RS_INVALID_HOLD_REASON_ Hold Reason Code &P_HOLD_REASON_CODE
COD is Not Valid.
210243 E JTF_RS_TEAM_NULL Team ID and Team Number are Null.
210244 E JTF_RS_INVALID_TEAM Team ID &P_TEAM_ID is Not Valid.
210245 E JTF_RS_INVALID_TEAM_NUMBER Team Number &P_TEAM_NUMBER is Not
Valid.
210254 E JTF_RS_ROW_LOCK_ERROR This record has been updated by another user.
Please requery and try again.
210259 E JTF_RS_USER_ID_NULL User ID cannot be Null.
210260 E JTF_RS_INVALID_USER_ID User ID &P_USER_ID is Not Valid.
HOOK User Hook.
HOOK Hook.
Generation API.
210275 E JTF_RS_ERR_RES_ROLE_START_ Resource Start Date out of range for the role
DATE related start dates of the Resource.
210276 E JTF_RS_ERR_RES_ROLE_END_DATE Resource End Date out of range for the role
related End dates of the Resource.
210277 E JTF_RS_ERR_RES_GMBR_START_ Resource Start Date out of range for the group
DATE member role related start dates for the Resource.
210278 E JTF_RS_ERR_RES_GMBR_END_DATE Resource End Date out of range for the group
member role related end dates for the Resource.
210279 E JTF_RS_ERR_RES_TMBR_START_ Resource Start Date out of range for the Team
DATE Member role related start dates for the Resource,
where the Team Member is a Resource.
210280 E JTF_RS_ERR_RES_TMBR_END_DATE Resource End Date out of range for the Team
Member role related end dates for the Resource,
where the Team Member is a Resource.
210281 E JTF_RS_ERR_RES_SRP_START_DATE Resource Start Date out of range for the
salesperson related start dates of the resource.
210282 E JTF_RS_ERR_RES_SRP_END_DATE Resource End Date out of range for the
salesperson related End dates of the Resource.


210328 U JTF_RS_USERID_ERROR For the specified Category, User identifier should
be NULL.
210374 U JTF_RS_ERR_DUPLICATE_USER_ID The user identifier <User_id> already exist.
210393 U JTF_RS_UNEXP_ERROR An unexpected error was encountered in &P_
API_NAME.
380001 E JTF_RS_XMLGEN_ERR Package JTF_USR_HKS is invalid.
380002 E JTF_RS_JUHK_ERR Package JTF_USR_HKS is invalid.
380060 E JTF_RS_NOT_PRIMARY_ADDR The address ID passed in is not the primary
address of the PARTY/PARTNER.
2.5.2 JTF_RS_GROUPS_PUB
contained in the JTF_RS_GROUPS_PUB package.
2.5.2.1 Create_Resource_Group
Resource_Group API.
Table 2–16 Create_Resource_Group Messages

210201 U JTF_RS_GROUP_NAME_NULL Group Name cannot be NULL.
Date Active.
210261 E JTF_RS_ERR_PRE_CUST_USR_HOOK Returned Error status from the Pre Customer
User Hook.
210262 E JTF_RS_ERR_PRE_VERT_USR_HOOK Returned Error status from the Pre Vertical User
Hook.
HOOK User Hook.

Table 2–16 Create_Resource_Group Messages

HOOK Hook.
Generation API.
User Hook.
210371 E JTF_RS_ERR_PRE_INT_USR_HOOK Returned Error status from the Pre Internal User
Hook.
2.5.2.2 Update_Resource_Group
Resource_Group API.
Table 2–17 Update_Resource_Group Messages

210201 U JTF_RS_GROUP_NAME_NULL Group Name cannot be NULL.
210246 E JTF_RS_ERR_ROLE_START_DATE Group Start Date Out of Range for the Related
Roles Start dates for the Group.
210247 E JTF_RS_ERR_ROLE_END_DATE Group End Date Out of Range for the Related
Roles End dates for the Group.
210248 E JTF_RS_ERR_GRP_MBR_START_DATE Group Start Date Out of Range for the Group
Member Role Related Start Dates.
210249 E JTF_RS_ERR_GRP_MBR_END_DATE Group End Date Out of Range for the Group
Member Role Related End Dates.
210250 E JTF_RS_ERR_GRP_REL_START_DATE Group Start Date Out of Range for the Group
Relations Related Start Dates.
210251 E JTF_RS_ERR_GRP_REL_END_DATE Group End Date Out of Range for the Group
Relations Related End Dates.
210252 E JTF_RS_ERR_TEAM_MBR_START_ Group Start Date Out of Range for the Team
DATE Member Role Related Start Dates for the Group,
where the Team Member is a Group.
210253 E JTF_RS_ERR_TEAM_MBR_END_DATE Group End Date Out of Range for the Team
Member Role Related End Dates for the Group,
where the Team Member is a Group.

Table 2–17 Update_Resource_Group Messages

210254 E JTF_RS_ROW_LOCK_ERROR This record has been updated by another user.
Please requery and try again.
User Hook.
Hook.
210264 E JTF_RS_EXCLUSIVE_GROUP Group usage cannot be created as one of the
member dates overlap with another record for
the same resource assigned to another exclusive
group with the same usage in the same time
period.
HOOK Hook.
210268 E JTF_RS_INVALID_GROUP Usage &P_USAGE is not setup for the Group ID
&P_GROUP_ID.
Hook.
2.5.3 JTF_RS_SALESREPS_PUB
contained in the JTF_RS_SALESREPS_PUB package.
2.5.3.1 Create_SalesRep
SalesRep API.
Table 2–18 Create_SalesRep Messages

210204 E JTF_RS_INVALID_RESOURCE Resource identifier <Resource_id> is not valid or
is inactive.
210207 U JTF_RS_RESOURCE_NULL Resource identifier and Resource Number are
NULL.
210208 E JTF_RS_INVALID_RESOURCE_ Resource Number <Resource_number> is not
NUMBER valid or the resource is inactive.

Table 2–18 Create_SalesRep Messages

210219 E JTF_RS_START_DATE_NULL Start Date Active cannot be null.
Date Active.
User Hook.
Hook.
HOOK User Hook.
HOOK Hook.
Generation API.
210283 E JTF_RS_ERR_SALESREP_NUMBER Salesperson Number &P_SALESREP_NUMBER
already exists.
210284 E JTF_RS_SALESREP_NUMBER_NULL Salesperson Number cannot be Null.
210285 E JTF_RS_ERR_SALES_CREDIT_TYPE Sales Credit Type identifier <Sales_credit_type_
id> is invalid.
210286 E JTF_RS_SALES_CREDIT_TYPE_NULL Sales Credit Type identifier cannot be NULL.
User Hook.
Hook.

2.5.3.2 Update_SalesRep
SalesRep API.
Table 2–19 Update_SalesRep Messages

210218 E JTF_RS_TABLE_HANDLER_ERROR Error in the Table Handler.
Date Active.
User Hook.
Hook.
HOOK User Hook.
HOOK Hook.
Generation API.
210283 E JTF_RS_ERR_SALESREP_NUMBER Salesperson Number &P_SALESREP_NUMBER
already exists.
210284 E JTF_RS_SALESREP_NUMBER_NULL Salesperson Number cannot be Null.
210285 E JTF_RS_ERR_SALES_CREDIT_TYPE Sales Credit Type identifier <Sales_credit_type_
id> is invalid.
210286 E JTF_RS_SALES_CREDIT_TYPE_NULL Sales Credit Type identifier cannot be NULL.
210315 E JTF_RS_SALESREP_ID_NULL Salesperson identifier cannot be NULL.
210316 E JTF_RS_INVALID_SALESREP_ID Salesperson identifier <Salesrep_id> is invalid.
User Hook.
Hook.

Sample Code
2.6 Sample Code

This section contains SQL scripts that call the Resource Manager public APIs stored
in the following packages and insert values as required:
■ JTF_RS_RESOURCE_PUB
■ JTF_RS_GROUPS_PUB
2.6.1 JTF_RS_RESOURCE_PUB
The SQL scripts in this section create and update a resource by calling the APIs
contained in the JTF_RS_RESOURCE_PUB package in succession and by providing
them with the appropriate values.
2.6.1.1 Create_Resource
This script calls the Create_Resource API and provides the values listed in the
following table using the Create_Resource IN parameters. Calling applications can
optionally insert more values than the ones listed in this section.
Table 2–20 Create_Resource API Sample Code Variables

Variable Description
l_api_version Version is 1.0.
l_category Category is Employee.
l_source_id Source ID is equal to 10001.
l_resource_name Resource name is Rachel Abbott.
l_managing_emp_id Her employee ID number is 1100.
l_user_id User ID is 2294.
l_time_zone Time zone is 92.
l_cost_per_hr Her rate is $25.00 per hour.
l_primary_language The primary language is American English.
l_secondary_language The secondary language is Candian French.
l_support_site_id The support site ID number is 22917.
l_ies_agent_login The agent login is "guest".

Sample Code
Table 2–20 Create_Resource API Sample Code Variables

l_server_group_id The server group ID number is 112.
l_interaction_center_name The interaction center name for the group is
"CCTAGENT01'.
l_assigned_to_group_id The assigned group ID number is 1548.
l_cost_center The cost center number is OA55.
l_charge_to_cost_center The charge to the cost center is 250.
l_comp_currency_code The currency code is AUD.
l_commissionable_flag The flag is set to "Y".
l_hold_reason_code The hold reason code is HRC-1.
l_hold_payment The hold payment flag is set to "N".
l_comp_service_team_id The comp service team ID is 10072.
l_source_name The source name is Abbott, Ms. Rachel (Rachel).
l_source_number The source number is 159.
l_source_job_title The source title is SAL600.Sales Representative.
l_source_email Her email address is [email protected].
l_source_phone Her phone number is 650-555-1212.
SET SERVEROUTPUT ON
declare
l_api_version number := 1.0;

l_category jtf_rs_resource_extns.category%type := 'EMPLOYEE';
l_source_id jtf_rs_resource_extns.source_id%type := 10001;
l_resource_name jtf_rs_resource_extns_tl.resource_name%type := 'Rachel Abbott';
l_managing_emp_id jtf_rs_resource_extns.managing_employee_id%type := 1100;
l_user_id jtf_rs_resource_extns.user_id%type := 2294;
l_time_zone jtf_rs_resource_extns.time_zone%type := 92;
l_cost_per_hr jtf_rs_resource_extns.cost_per_hr%type := 25;
l_primary_language jtf_rs_resource_extns.primary_language%type := 'AMERICAN';
l_secondary_language jtf_rs_resource_extns.secondary_language%type := 'CANADIAN FRENCH';
l_support_site_id jtf_rs_resource_extns.support_site_id%type := 22917;
l_ies_agent_login jtf_rs_resource_extns.ies_agent_login%type := 'guest';
l_server_group_id jtf_rs_resource_extns.server_group_id%type := 112;

Sample Code
l_interaction_center_name ieo_svr_groups.group_name%type := 'CCTAGENT01';

l_assigned_to_group_id jtf_rs_resource_extns.assigned_to_group_id%type := 1548;
l_cost_center jtf_rs_resource_extns.cost_center%type := '0A55';
l_charge_to_cost_center jtf_rs_resource_extns.charge_to_cost_center%type := '250';
l_comp_currency_code jtf_rs_resource_extns.compensation_currency_code%type := 'AUD';
l_commissionable_flag jtf_rs_resource_extns.commissionable_flag%type := 'Y';
l_hold_reason_code jtf_rs_resource_extns.hold_reason_code%type := 'HRC-1';
l_hold_payment jtf_rs_resource_extns.hold_payment%type := 'N';
l_comp_service_team_id jtf_rs_resource_extns.comp_service_team_id%type := 10072;
l_source_name jtf_rs_resource_extns.source_name%type := 'Abbott, Ms. Rachel
(Rachel)';
l_source_number jtf_rs_resource_extns.source_number%type := 159;
l_source_job_title jtf_rs_resource_extns.source_job_title%type := 'SAL600.Sales
Representative';
l_source_email jtf_rs_resource_extns.source_email%type := '[email protected]';
l_source_phone jtf_rs_resource_extns.source_phone%type := '650-555-1212';
l_return_status varchar2(1);
l_msg_count number;
l_msg_data varchar2(2000);
l_resource_id jtf_rs_resource_extns.resource_id%type;
l_resource_number jtf_rs_resource_extns.resource_number%type;
l_msg_data1 varchar2(2000);
l_msg_index_out number;
begin
jtf_rs_resource_pub.create_resource
(P_API_VERSION => l_api_version,
P_CATEGORY => l_category,
P_START_DATE_ACTIVE => sysdate,
P_END_DATE_ACTIVE => null,
P_SOURCE_ID => l_source_id,
P_RESOURCE_NAME => l_resource_name,
P_MANAGING_EMP_ID => l_managing_emp_id,
P_USER_ID => l_user_id,
P_TIME_ZONE => l_time_zone,
P_COST_PER_HR => l_cost_per_hr,
P_PRIMARY_LANGUAGE => l_primary_language,
P_SECONDARY_LANGUAGE => l_secondary_language,
P_SUPPORT_SITE_ID => l_support_site_id,
P_IES_AGENT_LOGIN => l_ies_agent_login,
P_SERVER_GROUP_ID => l_server_group_id,
P_INTERACTION_CENTER_NAME => l_interaction_center_name,
P_ASSIGNED_TO_GROUP_ID => l_assigned_to_group_id,
P_COST_CENTER => l_cost_center,
P_CHARGE_TO_COST_CENTER => l_charge_to_cost_center,
P_COMP_CURRENCY_CODE => l_comp_currency_code,
P_COMMISSIONABLE_FLAG => l_commissionable_flag,

Sample Code
P_HOLD_REASON_CODE => l_hold_reason_code,

P_HOLD_PAYMENT => l_hold_payment,
P_COMP_SERVICE_TEAM_ID => l_comp_service_team_id,
P_SOURCE_NAME => l_source_name,
P_SOURCE_NUMBER => l_source_number,
P_SOURCE_JOB_TITLE => l_source_job_title,
P_SOURCE_EMAIL => l_source_email,
P_SOURCE_PHONE => l_source_phone,
X_RETURN_STATUS => l_return_status,
X_MSG_COUNT => l_msg_count,
X_MSG_DATA => l_msg_data,
X_RESOURCE_ID => l_resource_id,
X_RESOURCE_NUMBER => l_resource_number
);
if (l_return_status <> 'S') then

if (fnd_msg_pub.count_msg > 0) then
for i in 1..fnd_msg_pub.count_msg loop
fnd_msg_pub.get
(p_msg_index => i,
p_data => l_msg_data,
p_encoded => 'F',
p_msg_index_out => l_msg_index_out
);
l_msg_data1 := l_msg_data1 ||' '|| l_msg_data;
end loop;
fnd_message.set_encoded(l_msg_data1);
dbms_output.put_line(l_msg_data1);
end if;
else
dbms_output.put_line ('Return Status - ' || l_return_status);
dbms_output.put_line ('Resource ID - ' || l_resource_id);
dbms_output.put_line ('Resource Number - '|| l_resource_number);
end if;
end;
/
2.6.1.2 Update_Resource
This script calls the Update_Resource API and provides the values listed in the
following table using the Update_Resource IN parameters. Calling applications can
Table 2–21 Update_Resource API Sample Code Variables


Sample Code
Table 2–21 Update_Resource API Sample Code Variables

1_resource_id The resource ID is 10000.
1_resource_number The resource number is 10005.
l_resource_name Resource name is Rachel Abbott.
l_managing_emp_id Her employee ID number is 1100.
l_user_id User ID is 2294.
l_time_zone Time zone is 92.
l_cost_per_hr Her rate is $25.00 per hour.
l_primary_language The primary language is American English.
l_secondary_language The secondary language is Candian French.
l_support_site_id The support site ID number is 22917.
l_ies_agent_login The agent login is "guest".
l_server_group_id The server group ID number is 112.
l_assigned_to_group_id The assigned group ID number is 1548.
l_cost_center The cost center number is OA55.
l_charge_to_cost_center The charge to the cost center is 250.
l_comp_currency_code The currency code is AUD.
l_commissionable_flag The flag is set to "Y".
l_hold_reason_code The hold reason code is HRC-1.
l_hold_payment The hold payment flag is set to "N".
l_comp_service_team_id The comp service team ID is 10072.
l_source_name The source name is Abbott, Ms. Rachel (Rachel).
l_source_number The source number is 159.
l_source_job_title The source title is SAL600.Sales Representative.
l_source_email Her email address is [email protected].
l_source_phone Her phone number is 650-555-1212.
SET SERVEROUTPUT ON

Sample Code
declare

l_resource_id jtf_rs_resource_extns.resource_id%type := 10000;
l_resource_number jtf_rs_resource_extns.resource_number%type := '10005';
l_resource_name jtf_rs_resource_extns_tl.resource_name%type := 'Rachel Abbott';
l_managing_emp_id jtf_rs_resource_extns.managing_employee_id%type := 1100;
l_user_id jtf_rs_resource_extns.user_id%type := 2294;
l_time_zone jtf_rs_resource_extns.time_zone%type := 92;
l_cost_per_hr jtf_rs_resource_extns.cost_per_hr%type := 25;
l_primary_language jtf_rs_resource_extns.primary_language%type := 'AMERICAN';
l_secondary_language jtf_rs_resource_extns.secondary_language%type := 'CANADIAN FRENCH';
l_support_site_id jtf_rs_resource_extns.support_site_id%type := 22917;
l_ies_agent_login jtf_rs_resource_extns.ies_agent_login%type := 'guest';
l_server_group_id jtf_rs_resource_extns.server_group_id%type := 112;
l_assigned_to_group_id jtf_rs_resource_extns.assigned_to_group_id%type := 1548;
l_cost_center jtf_rs_resource_extns.cost_center%type := '0A55';
l_charge_to_cost_center jtf_rs_resource_extns.charge_to_cost_center%type := '250';
l_comp_currency_code jtf_rs_resource_extns.compensation_currency_code%type := 'AUD';
l_commissionable_flag jtf_rs_resource_extns.commissionable_flag%type := 'Y';
l_hold_reason_code jtf_rs_resource_extns.hold_reason_code%type := 'HRC-1';
l_hold_payment jtf_rs_resource_extns.hold_payment%type := 'N';
l_comp_service_team_id jtf_rs_resource_extns.comp_service_team_id%type := 10072;
l_source_name jtf_rs_resource_extns.source_name%type := 'Abbott, Ms. Rachel
(Rachel)';
l_source_number jtf_rs_resource_extns.source_number%type := 159;
l_source_job_title jtf_rs_resource_extns.source_job_title%type := 'SAL600.Sales
Representative';
l_source_email jtf_rs_resource_extns.source_email%type := '[email protected]';
l_source_phone jtf_rs_resource_extns.source_phone%type := '650-555-1212';
l_object_version_number jtf_rs_resource_extns.object_version_number%type;
l_msg_count number;
begin
select object_version_number
into l_object_version_number
from jtf_rs_resource_extns
where resource_id = l_resource_id;
jtf_rs_resource_pub.update_resource
P_RESOURCE_ID => l_resource_id,
P_RESOURCE_NUMBER => l_resource_number,

Sample Code
P_START_DATE_ACTIVE => sysdate,

P_END_DATE_ACTIVE => null,
P_RESOURCE_NAME => l_resource_name,
P_MANAGING_EMP_ID => l_managing_emp_id,
P_USER_ID => l_user_id,
P_TIME_ZONE => l_time_zone,
P_COST_PER_HR => l_cost_per_hr,
P_PRIMARY_LANGUAGE => l_primary_language,
P_SECONDARY_LANGUAGE => l_secondary_language,
P_SUPPORT_SITE_ID => l_support_site_id,
P_IES_AGENT_LOGIN => l_ies_agent_login,
P_SERVER_GROUP_ID => l_server_group_id,
P_ASSIGNED_TO_GROUP_ID => l_assigned_to_group_id,
P_COST_CENTER => l_cost_center,
P_CHARGE_TO_COST_CENTER => l_charge_to_cost_center,
P_COMP_CURRENCY_CODE => l_comp_currency_code,
P_COMMISSIONABLE_FLAG => l_commissionable_flag,
P_HOLD_REASON_CODE => l_hold_reason_code,
P_HOLD_PAYMENT => l_hold_payment,
P_COMP_SERVICE_TEAM_ID => l_comp_service_team_id,
P_SOURCE_NAME => l_source_name,
P_SOURCE_NUMBER => l_source_number,
P_SOURCE_JOB_TITLE => l_source_job_title,
P_SOURCE_EMAIL => l_source_email,
P_SOURCE_PHONE => l_source_phone,
P_OBJECT_VERSION_NUM => l_object_version_number,
X_MSG_DATA => l_msg_data
);

fnd_msg_pub.get
(p_msg_index => i,
p_encoded => 'F',
);
end loop;
end if;
else
end if;
end;

Sample Code
2.6.2 JTF_RS_GROUPS_PUB
The SQL scripts in this section create and update a resource group by calling the
APIs contained in the JTF_RS_GROUPS_PUB package in succession and by
providing them with the appropriate values.
2.6.2.1 Create_Resource_Group Sample Code

This script calls the Create_Resource_Group API and provides the values listed in
the following table using the Create_Resource_Group IN parameters. Calling
applications can optionally insert more values than the ones listed in this section..
Table 2–22 Create_Resource_Group API Sample Code Variables

l_group_name The group name is Sales Group.
l_group_desc The description of the group is Sales Group Representative.
l_exclusive_flag The exclusive flag is set to "Y".
l_email_address The group’s email address is [email protected].
l_start_date_active The start date is the same as the sysdate.
l_end_date_active The active end date is set to null.
l_accounting_code The accounting code is "Payment".
SET SERVEROUTPUT ON
declare

l_group_name jtf_rs_groups_vl.group_name%type := 'Sales Group';
l_group_desc jtf_rs_groups_vl.group_desc%type := 'Sales Group
Representative';
l_exclusive_flag jtf_rs_groups_b.exclusive_flag%type := 'Y';
l_email_address jtf_rs_groups_b.email_address%type := '[email protected]';
l_start_date_active jtf_rs_groups_b.start_date_active%type := sysdate;
l_end_date_active jtf_rs_groups_b.end_date_active%type := null;

Sample Code
l_accounting_code jtf_rs_groups_b.accounting_code%type := 'Payment';
l_msg_count number;
l_group_id jtf_rs_groups_b.group_id%type;
l_group_number jtf_rs_groups_b.group_number%type;
begin
jtf_rs_groups_pub.create_resource_group
P_GROUP_NAME => l_group_name,
P_GROUP_DESC => l_group_desc,
P_EXCLUSIVE_FLAG => l_exclusive_flag,
P_ACCOUNTING_CODE => l_accounting_code,
P_EMAIL_ADDRESS => l_email_address,
P_START_DATE_ACTIVE => l_start_date_active,
P_END_DATE_ACTIVE => l_end_date_active,
X_GROUP_ID => l_group_id,
X_GROUP_NUMBER => l_group_number
);

fnd_msg_pub.get
(p_msg_index => i,
p_encoded => 'F',
);
end loop;
end if;
else

Sample Code
dbms_output.put_line ('Group ID - ' || l_group_id);

dbms_output.put_line ('Group Number - ' || l_group_number);
end if;
end;
/
2.6.2.2 Update_Resource_Group Sample Code

This script calls theUpdate_Resource_Group API and provides the values listed in
the following table using the Update_Resource_Group IN parameters. Calling
applications can optionally insert more values than the ones listed in this section.
Table 2–23 Update_Resource_Group API Sample Code Variables

l_group_id The group ID is 10000.
l_group_desc The description of the group is Sales Group Representative.
l_group_number The group number is 10005.

l_group_name The group name is "Sales Group".
l_group_desc The group description is Sales Group Representative.
l_exclusive_flag The exclusive flag is set to "Y".
l_email_address The group’s email address is [email protected].
l_start_date_active The start date is the same as the sysdate.
l_end_date_active The active end date is set to null.
l_accounting_code The accounting code is "Payment".
SET SERVEROUTPUT ON
declare

l_group_id jtf_rs_groups_b.group_id%type := 10000;
l_group_number jtf_rs_groups_b.group_number%type := '10005';
l_group_name jtf_rs_groups_vl.group_name%type := 'Sales Group';
l_group_desc jtf_rs_groups_vl.group_desc%type := 'Sales Group Representative';
l_exclusive_flag jtf_rs_groups_b.exclusive_flag%type := 'Y';
l_email_address jtf_rs_groups_b.email_address%type := '[email protected]';

Sample Code
l_start_date_active jtf_rs_groups_b.start_date_active%type := sysdate;

l_end_date_active jtf_rs_groups_b.end_date_active%type := null;
l_accounting_code jtf_rs_groups_b.accounting_code%type := 'Payment';
l_object_version_number jtf_rs_groups_b.object_version_number%type;
l_msg_count number;
begin
from jtf_rs_groups_b
where group_id = l_group_id;
jtf_rs_groups_pub.update_resource_group
P_GROUP_ID => l_group_id,
P_GROUP_NUMBER => l_group_number,
P_GROUP_NAME => l_group_name,
P_GROUP_DESC => l_group_desc,
P_EXCLUSIVE_FLAG => l_exclusive_flag,
P_ACCOUNTING_CODE => l_accounting_code,
P_OBJECT_VERSION_NUM => l_object_version_number,
);

fnd_msg_pub.get
(p_msg_index => i,
p_encoded => 'F',
);
end loop;
end if;
else

Sample Code

end if;
end;
/
2.6.3 JTF_RS_SALESREPS_PUB
The SQL scripts in this section create and update a sales representative by calling
the APIs contained in the JTF_RS_SALESREPS_PUB package in succession and by
providing them with the appropriate values.
2.6.3.1 Create_SalesRep Sample Code

This script calls the Create_SalesRep API and provides the values listed in the
following table using the Create_SalesRep IN parameters. Calling applications can
Table 2–24 Create_SalesRep API Sample Code Variables

l_resource_id The resouce ID number is 10001.
l_sales_credit_type_id The sales credit type ID is 5.
l_name The name is set to John Doe.
l_status The status is set to "A".
l_start_date_active The start date is equal to the sysdate.

l_end_date_active The end date is set to null.
l_gl_id_rev The global ID is 17736.

l_gl_id_freight The global freight ID is 17734.
l_gl_id_rec The global REC ID is 17703.
l_set_of_books_id The set of books ID is 23.
l_salesrep_number The salesrep number is 42549.

l_email_address The email address is [email protected]

Sample Code
Table 2–24 Create_SalesRep API Sample Code Variables

l_wh_update_date Wh_update is equal to the sysdate.
l_sales_tax_geocode The sales tax geocode is set to null.
l_sales_tax_inside_city_ The sales tax inside city limits is set to null.

limits
SET SERVEROUTPUT ON
declare

l_resource_id jtf_rs_salesreps.resource_id%type := 10001;
l_sales_credit_type_id jtf_rs_salesreps.sales_credit_type_id%type := 5;
l_name jtf_rs_salesreps.name%type := 'John Doe';
l_status jtf_rs_salesreps.status%type := 'A';
l_start_date_active jtf_rs_salesreps.start_date_active%type := sysdate;
l_end_date_active jtf_rs_salesreps.end_date_active%type := null;
l_gl_id_rev jtf_rs_salesreps.gl_id_rev%type := 17736;
l_gl_id_freight jtf_rs_salesreps.gl_id_freight%type := 17734;
l_gl_id_rec jtf_rs_salesreps.gl_id_rec%type := 17703;
l_set_of_books_id jtf_rs_salesreps.set_of_books_id%type := 23;
l_salesrep_number jtf_rs_salesreps.salesrep_number%type := '42549';
l_email_address jtf_rs_salesreps.email_address%type :=
'[email protected]';
l_wh_update_date jtf_rs_salesreps.wh_update_date%type := sysdate;
l_sales_tax_geocode jtf_rs_salesreps.sales_tax_geocode%type := null;
l_sales_tax_inside_city_limits jtf_rs_salesreps.sales_tax_inside_city_limits%type := null;
l_msg_count number;
l_salesrep_id jtf_rs_salesreps.salesrep_id%type;
begin
jtf_rs_salesreps_pub.create_salesrep
P_RESOURCE_ID => l_resource_id,
P_SALES_CREDIT_TYPE_ID => l_sales_credit_type_id,
P_NAME => l_name,
P_STATUS => l_status,

Sample Code

P_GL_ID_REV => l_gl_id_rev,
P_GL_ID_FREIGHT => l_gl_id_freight,
P_GL_ID_REC => l_gl_id_rec,
P_SET_OF_BOOKS_ID => l_set_of_books_id,
P_SALESREP_NUMBER => l_salesrep_number,
P_WH_UPDATE_DATE => l_wh_update_date,
P_SALES_TAX_GEOCODE => l_sales_tax_geocode,
P_SALES_TAX_INSIDE_CITY_LIMITS => l_sales_tax_inside_city_limits,
X_SALESREP_ID => l_salesrep_id
);

fnd_msg_pub.get
(p_msg_index => i,
p_encoded => 'F',
);
end loop;
end if;
else
dbms_output.put_line ('Salesperson ID - ' || l_salesrep_id);
end if;
end;
/
2.6.3.2 Update_SalesRep Sample Code

This script calls the Update_SalesRep API and provides the values listed in the
following table using the Update_SalesRep IN parameters. Calling applications can

Sample Code
Table 2–25 Update_SalesRep API Sample Code Variables

l_salesrep_id The salesrep ID is 1000.

l_sales_credit_type_id The sales credit type ID is 5.
l_name The name is set to John Doe.
l_status The status is set to "A".
l_start_date_active The start date is equal to the sysdate.

l_end_date_active The end date is set to null.
l_gl_id_rev The global ID is 17736.

l_gl_id_freight The global freight ID is 17734.
l_gl_id_rec The global REC ID is 17703.
l_set_of_books_id The set of books ID is 23.
l_salesrep_number The salesrep number is 42549.

l_email_address The email address is [email protected]
l_wh_update_date Wh_update is equal to the sysdate.
l_sales_tax_geocode The sales tax geocode is set to null.
l_sales_tax_inside_city_ The sales tax inside city limits is set to null.

limits
l_org_id The org ID is set to 204.
SET SERVEROUTPUT ON
declare

l_salesrep_id jtf_rs_salesreps.salesrep_id%type := 1000;
l_sales_credit_type_id jtf_rs_salesreps.sales_credit_type_id%type := 5;
l_name jtf_rs_salesreps.name%type := 'John
Doe';
l_status jtf_rs_salesreps.status%type := 'A';
l_start_date_active jtf_rs_salesreps.start_date_active%type := sysdate;
l_end_date_active jtf_rs_salesreps.end_date_active%type := null;

Sample Code
l_gl_id_rev jtf_rs_salesreps.gl_id_rev%type := 17736;

l_gl_id_freight jtf_rs_salesreps.gl_id_freight%type := 17734;
l_gl_id_rec jtf_rs_salesreps.gl_id_rec%type := 17703;
l_set_of_books_id jtf_rs_salesreps.set_of_books_id%type := 23;
l_salesrep_number jtf_rs_salesreps.salesrep_number%type := '42549';
l_email_address jtf_rs_salesreps.email_address%type :=
'[email protected]';
l_wh_update_date jtf_rs_salesreps.wh_update_date%type := sysdate;
l_sales_tax_geocode jtf_rs_salesreps.sales_tax_geocode%type := null;
l_sales_tax_inside_city_limits jtf_rs_salesreps.sales_tax_inside_city_limits%type := null;
l_org_id jtf_rs_salesreps.org_id%type := 204;
l_object_version_number jtf_rs_salesreps.object_version_number%type;
l_msg_count number;
begin
from jtf_rs_salesreps
where salesrep_id = l_salesrep_id;
jtf_rs_salesreps_pub.update_salesrep
P_SALESREP_ID => l_salesrep_id,
P_SALES_CREDIT_TYPE_ID => l_sales_credit_type_id,
P_NAME => l_name,
P_STATUS => l_status,
P_GL_ID_REV => l_gl_id_rev,
P_GL_ID_FREIGHT => l_gl_id_freight,
P_GL_ID_REC => l_gl_id_rec,
P_SET_OF_BOOKS_ID => l_set_of_books_id,
P_SALESREP_NUMBER => l_salesrep_number,
P_WH_UPDATE_DATE => l_wh_update_date,
P_SALES_TAX_GEOCODE => l_sales_tax_geocode,
P_SALES_TAX_INSIDE_CITY_LIMITS => l_sales_tax_inside_city_limits,
P_ORG_ID => l_org_id,
P_OBJECT_VERSION_NUMBER => l_object_version_number,

Sample Code

);

fnd_msg_pub.get
(p_msg_index => i,
p_encoded => 'F',
);
end loop;
end if;
else
end if;
end;
/

3
Task Manager Public APIs
Task Manager provides Oracle e-Business Suite products with task management
capability. Task Manager can be accessed as a standalone module or as an
integrated component of other applications. When Task Manager is called by
another application the values supplied by that application populate the relevant
Task Manager fields. Other e-Business Suite modules call the Task Manager public
APIs to insert, update, delete, and query task records.
Note: In Applications release 11.5.9, many of the Task Manager’s

PL/SQL server side APIs have been enhanced to utilize the pass by
reference semantics of PL/SQL. This improves performance
considerably and reduces memory consumption. In the normal
processing case (i.e. success), there is no change of behavior, and
callers of these APIs are not impacted. However, in the case of
exceptions, there is a behavior change which results in assignments
being exposed to the caller, which are made in the API prior to any
exceptions being raised. The previous behavior would rollback
these assignments made by the API if an exception occurred in this
API. Developers writing custom extensions to Oracle Applications,
or third party integrators which use the standard Applications'
APIs should be aware of this change in semantics.
This chapter discusses the following topics:

■ Task Manager Public Packages
■ Sample Code
Task Manager Public APIs 3-1

Task Manager Public Packages
3.1 Task Manager Public Packages

All public procedures (APIs) relating to creating, updating, or deleting tasks, task
references, or task assignments are stored in the following public packages:
■ JTF_TASKS_PUB
■ JTF_TASK_ASSIGNMENTS_PUB
The following tables describe the Task Manager public APIs.
Table 3–1 Tasks APIs

Create_Task Creates a task and provides the task with values supplied by
the calling application. It also creates the dependencies,
resource requirements, assignments, references, dates,
recurrences, and contacts.
Update_Task Updates a task with values supplied by the calling
application.
Delete_Task Soft deletes a task by marking the task as deleted without
removing the task record from the database table in which it
is stored.
Table 3–2 Task Assignments APIs

Create_Task_Assignment Creates a task assignment for a specified task. The level of
effort can be specified for each resource assigned to the task.
Update_Task_Assignment Updates a task assignment for a given task. For each resource
assigned to the task, the actual effort can be specified.
Delete_Task_Assignment Deletes a task assignment for a specified task.
Table 3–3 Task References APIs

Create_References Creates references to a task. For example, a task created for a
service request can establish reference to an inventory part
number using references.
Update_References Updates references to a task.

Table 3–3 Task References APIs

Delete_References Deletes references to a task.
Note:
The following are referenced throughout the table’s "Validations and
Descriptions" column in all of the Task APIs.
1. The Task APIs support calls by values not internal IDs. For example, the
Account Number can be passed to the API instead of the Account ID.
However, using these IDs improves the API performance.
2. The customer account should belong to the same customer which is
specified for the task.
3. The address (party_site_id and party_site_number) specified for the task,
should be the address registered for the customer in the TCA schema. The
address can only be specified if the customer for the task is specified. In
addition, the customer address specified for the task must be specified for
the same customer at the task level.
4. To specifiy the unit of measure (UOM) for the effort and duration fields, the
profile jtf_time_uom_class must be populated with the unit of measure class.
For example, the customer can create a unit of measure class called TIME.
The profile must be populated with this value. Further, the customer should
create unit of measure codes such as minutes, hours, and days for the Time
class. While specifying values to the APIs, the customer can pass values for
these unit of measure codes.
5. Child and Parent tasks must have the same source. For example, the child
task cannot have the source as Lead and the Parent task cannot have the
source as Service Request.
6. Each task must have an owner associated with it. The owner for a task can
be populated with the following two fields:
* Owner_type_code (for example rs_employee)
* Owner_id (for example resource_id of the employee)
The owner_type_code is a Foreign Key to jtf_objects_vl for objects with a usage
of "Resources." The object definition in jtf_objects contains all the relevant

information to create a PL/SQL statement. Using this PL/SQL statement,

the owner_id is validated.
For example, for rs_employee, the SELECT statement that is created at run
time is:
SELECT resource_id, full_name from JTF_RS_EMP_DTLS_VL
Owner IDs passed to this API are validated against resources in the system.
7. Every task is associated with a source. Some examples of sources are:
Service Requests, Leads, Opportunity, Campaigns, Defects, and Contracts.
The source of a task drives most of the business rules for the task.
For example, Service Request #100 is the source for Task #101, Task #105,
and Task #107. Therefore, the parent entity, Service Request #100, can create
multiple tasks with the same source.
To create a source, the entity must be defined in JTF_OBJECTS. This can be
accomplished by logging into CRM Administrator Responsibility >Task
and Escalation Manager > Setups > Objects Meta > Data.
Continuing with the previous example, you will have the values of the
parameters to create a task with a source of Service Request # 100.
p_source_object_type_code = SR
p_source_object_id = 100
p_source_object_name = A101
The Source_object_type_code is a Foreign Key to the JTF_OBJECTS with a
usage of Task.
The source_object_id is the internal identifier which represents the instance
of the source, in this case, service request identifier. This is generally the
Primary Key of the "Source table," in this case, service request table.
The p_source_object_name is the external identifier which represents the
instance of the source, in this case, service request number. The source
object name is displayed on the user interface.
The same concept is used to established references to a task.
8. While updating or deleting any of the three public packages: tasks, task
assignments, or task references, the object_version_number must be passed to
the APIs. If the object_version_number that is passed into the API is the same
as in the tables (tasks, assignments, and references), then the attempt is
made to update or delete the record. Otherwise, an error is returned. You

Package JTF_TASKS_PUB
should get the object_version_number when selecting the record, then pass it
to the update and delete APIs.
3.2 Package JTF_TASKS_PUB

The JTF_TASKS_PUB API contains the following APIs:
■ Create_Task
■ Update_Task
■ Delete_Task
3.2.1 Data Structure Specifications

The following data structures are used in the JTF_TASKS_PUB API:
■ Task Assign Record Type
■ Task Dependency Record Type
■ Task Reference Record Type
■ Task Recurrence Record Type
■ Task Dates Record Type
■ Task Contact Record Type
■ Task Notes Record Type
■ Sort Record Type
3.2.1.1 Task Assign Record Type

This composite record type enumerates task assignment details that are ultimately
stored in the JTF_TASK_ASSIGN table.
TYPE task_assign_rec IS RECORD.
(
resource_type_code number,
resource_id number,
actual_start_date date := null,
actual_end_date date := null,
actual_effort_duration number := null,
actual_effort_dur_uom varchar2(3) := null,
scheduled_travel_distance number :=null,
scheduled_travel_duration number :=null,

scheduled_travel_duration_uom varchar2(3) :=null,

actual_travel_distance number :=null,
actual_travel_duration number :=null,
scheduled_travel_duration_uom varchar2(3) :=null,
schedule_flag varchar2(1) := null,
alarm_type_code varchar2(30) := null,
alarm_contact varchar2(200) := null
);
3.2.1.2 Task Dependency Record Type

This composite record type enumerates the dependency information between two
tasks that is ultimately stored in the JTF_TASK_DEPENDS table. When
template_flag =’Y’, the dependency exists between the templates. When this field is
not set to ’Y’ the dependency exists between the tasks. The Adjustment_time and
adjustment_time_uom fields indicate the lead or lag time between the two tasks.
TYPE task_depends_rec IS RECORD.
(
dependent_on_task_id number,
dependent_on_task_number number := null,
dependency_type_code varchar2(30),
adjustment_time number := null,
adjustment_time_uom varchar2(3) := null
);
3.2.1.3 Task Reference Record Type

This composite record type enumerates the reference details for a specific task that
are ultimately stored in the JTF_TASK_REFERENCES table. The reference_code field
retreives the value from Lookup code stored in the
JTF_TASK_REFERENCE_CODES table.
TYPE task_refer_rec IS RECORD.
(
object_type_code varchar2(10),
object_type_name varchar2(80)
object_name varchar2(80),
object_id number,
object_details varchar2(2000),
reference_code varchar2(30),
usage varchar2(2000)
);

3.2.1.4 Task Recurrence Record Type

This composite record type enumerates recurring task information that is ultimately
stored in the JTF_TASK_RECUR_REC table.
TYPE task_recur_rec IS RECORD.
(
occurs_which number,
day_of_week number,
date_of_month number,
occurs_month number,
occurs_uom varchar2(3),
occurs_every number,
occurs_number number
start_date_active date := null,
end_date_active date := null
);
3.2.1.5 Task Dates Record Type

This composite record type enumerates task date values that are ultimately stored
in the JTF_TASK_DATES table. The date_type_id field is a foreign key to the
JTF_TASK_DATE_TYPES table.
TYPE task_dates_rec IS RECORD.
(
date_type_id number default null,
date_type_name varchar2(30) default null,
date_type varchar2(30) default null,
date_value date
);
3.2.1.6 Task Contact Record Type

This composite record type enumerates customer contact information that is
ultimately stored in the JTF_TASK_CONTACTS table.
TYPE task_contacts_rec IS RECORD.
(
contact_id number default null,
contact_type_code varchar2(30) default null,
escalation_notify_flag varchar2(1) default null,
escalation_requester_flag varchar2(1) default null
);

3.2.1.7 Task Notes Record Type

This composite record type enumerates notes information that is ultimately stored
in the JTF_TASK_NOTES table.
TYPE task_notes_rec IS RECORD
(
parent_note_id number,
org_id number,
notes varchar2(4000),
notes_detail varchar2(32767),
note_status varchar2(1),
entered_by number,
entered_date date,
note_type varchar2(30),
jtf_note_id number,
attribute1 varchar2(150),
context varchar2(30)
);
3.2.1.8 Sort Record Type

This composite record type enumerates task sorting information that is ultimately
stored in the SORT_REC table.
TYPE sort_rec IS RECORD
(
field_name varchar2(30),
asc_dsc_flag char(1) default 'A'
);

3.2.2 Create_Task
This procedure creates a task with the given specifications. Also, it creates the
dependencies, resource requirements, assignments, references, dates, recurrences,
and contacts for the task created.
PROCEDURE create_task
(
p_task_id in number default null,
p_task_name in varchar2,
P_task_type_name in varchar2 default null,
p_task_type_id in number default null,
p_description in varchar2 default null,
p_task_status_name in varchar2 default null,
p_task_status_id in number default null,
p_task_priority_name in varchar2 default null,
p_task_priority_id in number default null,
p_owner_type_name in varchar2 default null,
p_owner_type_code in varchar2 default null,
p_owner_id in number default null,
p_owner_territory_id in number default null,
p_assigned_by_name in varchar2 default null,
p_assigned_by_id in number default null,
p_customer_number in varchar2 default null,
p_customer_id in number default null,
p_cust_account_number in varchar2 default null,
p_cust_account_id in number default null,
p_address_id in number default null,
p_address_number in varchar2 default null,
p_planned_start_date in date default null,
p_planned_end_date in date default null,
p_scheduled_start_date in date default null,
p_scheduled_end_date in date default null,
p_actual_start_date in date default null,
p_actual_end_date in date default null,
p_timezone_id in number default null,
p_timezone_name in varchar2 default null,
p_source_object_type_code in varchar2 default null,
p_source_object_id in number default null,
p_source_object_name in varchar2 default null,

p_duration in number default null,

p_duration_uom in varchar2 default null,
p_planned_effort in number default null,
p_planned_effort_uom in varchar2 default null,
p_actual_effort in number default null,
p_actual_effort_uom in varchar2 default null,
p_percentage_complete in number default null,
p_reason_code in varchar2 default null,
p_private_flag in varchar2 default null,
p_publish_flag in varchar2 default null,
p_restrict_closure_flag in varchar2 default null,
p_multi_booked_flag in varchar2 default null,
p_milestone_flag in varchar2 default null,
p_holiday_flag in varchar2 default null,
p_billable_flag in varchar2 default null,
p_bound_mode_code in varchar2 default null,
p_soft_bound_flag in varchar2 default null,
p_workflow_process_id in number default null,
p_notification_flag in varchar2 default null,
p_notification_period in number default null,
p_notification_period_uom in varchar2 default null,
p_parent_task_number in varchar2 default null,
p_parent_task_id in number default null,
p_alarm_start in number default null,
p_alarm_start_uom in varchar2 default null,
p_alarm_on in varchar2 default null,
p_alarm_count in number default null,
p_alarm_interval in number default null,
p_alarm_interval_uom in varchar2 default null,
p_palm_flag in varchar2 default null,
p_wince_flag in varchar2 default null,
p_laptop_flag in varchar2 default null,
p_device1_flag in varchar2 default null,
p_costs in number default null,
p_currency_code in varchar2 default null,
p_escalation_level in varchar2 default null,
p_task_assign_tbl in task_assign_tbl default g_miss_task_assign_tbl,
p_task_depends_tbl in task_depends_tbl default g_miss_task_depends_tbl,
p_task_rsrc_req_tbl in task_rsrc_req_tbl default g_miss_task_rsrc_req_tbl,
p_task_refer_tbl in task_refer_tbl default g_miss_task_refer_tbl,
p_task_dates_tbl in task_dates_tbl default g_miss_task_dates_tbl,
p_task_notes_tbl in task_notes_tbl default g_miss_task_notes_tbl,
p_task_recur_rec in task_recur_rec default g_miss_task_recur_rec,

p_task_contacts_tbl in task_contacts_tbl default g_miss_task_contacts_tbl,

x_task_id out number,
p_attribute1 in varchar2 default null,
p_attribute_category in varchar2 default null,
p_date_selected in varchar2 default null,
p_category_id in number default null,
p_show_on_calendar in varchar2 default null,
p_owner_status_id in number default null,
p_template_id in number default null,
p_template_group_id in number default null,
p_enable_workflow in varchar2,
p_abort_workflow in varchar2
);
Current Version
1.0
Table 3–4 Create_Task IN Parameters

p_api_version NUMBER Yes See "Standard IN Parameters" on
page 1-3.


p_init_msg_list VARCHAR2 Yes See "Standard IN Parameters" on
page 1-3.
p_commit VARCHAR2 Yes See "Standard IN Parameters" on
page 1-3.
p_task_id NUMBER No Unique task identifier (Primary Key).
If task_id is not specificied, then the
task_id is automatically generated and
passed as an out parameter x_task_id.
p_task_name VARCHAR2 Yes This defines the task name.
p_task_type_ VARCHAR2 Yes This defines the task type name.
name
p_task_type_id NUMBER Yes This is the task type identifier.
p_description VARCHAR2 No This is the description of the task.
p_task_status_ VARCHAR2 No This defines the task status name.
name
p_task_status_id NUMBER No Unique task status identifier
p_task_priority_ VARCHAR2 No Currently not supported
name
p_task_priority_ NUMBER No This defines the task priority (Foreign
id Key to JTF_TASK_PRIORITIES).
p_owner_type_ VARCHAR2 Yes Owner type of the task (Foreign Key to
code JTF_OBJECTS_VL for an object with a
usage of "Resources").
p_owner_id NUMBER Yes Owner of the task (resource ID of the
task owner. Foreign key to JTF_RS_
RESOURCE_EXTNS_VL, JTF_RS_
GROUPS_VL, JTF_RS_TEAMS_VL
depending on the value of owner_type_
code).
p_owner_ NUMBER No Territory of the owner.
territory_id Currently not supported
p_assigned_by_ VARCHAR2 No Currently not supported
name
p_assigned_by_ NUMBER No This is the user who assigned the task,
id (Foreign Key to FND_USER).


p_customer_ VARCHAR2 No Customer number (Foreign Key to hz_
number parties.party_number).
p_customer_id NUMBER No This is the customer identifier (Foreign
Key to hz_parties.party_id).
p_cust_account_ VARCHAR2 No Customer account number (Foreign Key
number to hz_cust_accounts.cust_account_
number).
p_cust_account_ NUMBER No Customer account identifier (Foreign
id Key to hz_cust_accounts.cust_account_id).
The customer account should belong to
the same customer which is specified
for the task.
p_address_id NUMBER No This is the address identifier (Foreign
Key to hz_party_sites.party_site_id).
See Note: 3 on page 3-3.
p_address_ VARCHAR2 No Address number (Foreign Key to hz_
number party_sites.party_site_number).
p_planned_start_ DATE No This defines the Planned Start Date.
date
p_planned_end_ DATE No This defines the Planned End Date.
date
p_scheduled_ DATE No This defines the Scheduled Start Date.
start_date
p_scheduled_ DATE No This defines the Scheduled End Date.
end_date
p_actual_start_ DATE No This defines the Actual Start Date.
date
p_actual_end_ DATE No This defines the Actual End Date.
date
p_timezone_id NUMBER No This is the time zone identifier
(timezone for the planned, scheduled,
and actual dates.)
Foreign Key to hz_timezones.timezone_id.


p_timezone_ VARCHAR2 No Currently not supported.
name
p_source_object_ VARCHAR2 No The Source object code for the task.
type_code (Foreign Key to JTF_OBJECTS_VL for
objects with a usage of "Task").
p_source_object_ NUMBER No This is the internal ID of source object.
id
Validated from the table registered in
JTF_OBJECTS_VL for the object_type_
code.
p_source_object_ VARCHAR2 No This is the user–visible source object
name identifier.
code.
p_duration NUMBER No This defines the duration of task.
p_duration_uom VARCHAR2 No This defines the unit of measure for
duration.
p_planned_effort NUMBER No This defines the planned effort.
p_planned_ VARCHAR2 No This defines the unit of measure for
effort_uom planned effort.
p_actual_effort NUMBER No This defines the actual amount of effort
spent on a task by all assignees.
p_actual_effort_ VARCHAR2 No This defines the unit of measure for
uom actual work.
p_percentage_ NUMBER No This defines the percentage of
complete completion of the task.
p_reason_code VARCHAR2 No Reason for rejecting a task, reassigning
a task, etc.
p_private_flag VARCHAR2 No Indicates whether the task is private or
public. Checks if the value is Y or N.
p_publish_flag VARCHAR2 No Indicates whether the task should be
published. Checks if the value is Y or N.


p_restrict_ VARCHAR2 No Indicates whether completing the task
closure_flag is necessary for the source object to be
deemed complete. Checks if the value is
Y or N.
p_multi_booked_ VARCHAR2 No Indicates whether the task can book
flag resources that are already assigned to
other tasks. Checks if the value is Y or
N.
p_milestone_flag VARCHAR2 No Indicates whether the task is a
milestone delivery date. Checks if the
value is Y or N.
p_holiday_flag VARCHAR2 No Indicates whether the task can be
performed on holidays. Checks if the
value is Y or N.
p_billable_flag VARCHAR2 No Indicates whether the task is billable.
Checks if the value is Y or N.
p_bound_mode_ VARCHAR2 No For internal use only
code
p_soft_bound_ VARCHAR2 No For internal use only
flag
p_workflow_ NUMBER No Identifier of last workflow process
process_id launched for this task.
p_notification_ VARCHAR2 No Flag indicating whether notification
flag workflow will be automatically
launched.
p_notification_ NUMBER No Time before the scheduled start date
period that a notification is sent to the
assignees.
p_notification_ VARCHAR2 No This is the unit of measure for the
period_uom notification period.
p_parent_task_ VARCHAR2 No The Task number of the parent task.
number
p_parent_task_id NUMBER No The Task identifier of the parent task.
p_alarm_start NUMBER No Indicates when the first alarm should be
fired. This parameter is currently not
supported.


p_alarm_start_ VARCHAR2 No Unit of measure for alarm_start. This
uom parameter is currently not supported.
p_alarm_on VARCHAR2 No Indicates whether the alarm is on. This
parameter is currently not supported.
p_alarm_count NUMBER No Total number of alarms to fire. This
p_alarm_interval NUMBER No Alarm interval. This parameter is
currently not supported.
p_alarm_ VARCHAR2 No Unit of measure for alarm interval. This
interval_uom parameter is currently not supported.
p_palm_flag VARCHAR2 No Used by mobile devices. Checks if the
value is Y or N.
p_wince_flag VARCHAR2 No Used by mobile devices. Checks if the
value is Y or N.
p_laptop_flag VARCHAR2 No Used by mobile devices. Checks if the
value is Y or N.
p_device1_flag VARCHAR2 No Used by mobile devices. Checks if the
value is Y or N.
value is Y or N.
value is Y or N.
p_costs NUMBER No For internal use only
p_currency_code VARCHAR2 No For internal use only
p_escalation_ VARCHAR2 No Escalation level. This parameter is not
level used for the Task Module
p_task_assign_ TASK_ASSIGN_ No Table of PL/SQL records to specify the
tbl TBL assignment specifications of the task.
p_task_depends_ TASK_ No Table of PL/SQL records to specify the
tbl DEPENDS_TBL task dependencies.
p_task_rsrc_req_ TASK_RSRC_ No Table of PL/SQL records to specify the
tbl REQ_TBL resource requirements. This is not
supported.


p_task_refer_tbl TASK_REFER_ No Table of PL/SQL records to specify the
TBL task references.
p_task_dates_tbl TASK_DATES_ No Table of PL/SQL records to specify the
TBL task dates. Currently not supported.
p_task_notes_tbl TASK_NOTES_ No Table of PL/SQL records to specify the
TBL notes.
p_task_recur_rec TASK_RECUR_ No Table of PL/SQL records to specify the
REC task recurrences.
p_task_contacts_ TASK_ No Table of PL/SQL records to specify the
tbl CONTACTS_ task contacts.
TBL
p_attribute1 VARCHAR2 No Descriptive flexfield segment column
p_attribute_ VARCHAR2 No Descriptive flexfield structure defining
category column


p_date_selected VARCHAR2 No This date is copied from the Task profile
option and copied to the Calendar Start
date. Valid values include Planned,
Scheduled, or Actual.
p_category_id NUMBER No This defines the task category ID.
p_show_on_ VARCHAR2 No Displays Tasks on the HTML Calendar.
calendar Checks if the Value is Y or N.
p_owner_status_ NUMBER Yes The status of the task level.
id
p_template_id NUMBER No Identifier for when you are creating a
task from a template.
p_template_ NUMBER No Identifier for when you are creating a
group_id task from a template group.
p_enable_ VARCHAR2 Yes Determines whether or not to send
workflow automatic notifications from the
application. Checks if the value is Y or
N.
p_abort_ VARCHAR2 Yes Determines whether or not to abort the
workflow previous Workflow process before
starting the next one. Checks if the
value is Y or N.
Table 3–5 Create_Task Out Parameters

x_task_id NUMBER This is the task identifier.

3.2.3 Update_Task
This procedure updates a task with the given specifications. While calling the
Update_Task API, task_id and task_number should be input to the API. The task_id or
the task_number must be specified to indicate the task that is being updated.
PROCEDURE update_task
(
p_api_version in number
p_object_version_number in out number,
p_task_id in number default fnd_api.g_miss_num,
p_task_number in varchar2 default fnd_api.g_miss_char,
p_task_name in varchar2 default fnd_api.g_miss_char,
p_task_type_name in varchar2 default fnd_api.g_miss_char,
p_task_type_id in number default fnd_api.g_miss_num,
p_description in varchar2 default fnd_api.g_miss_char,
p_task_status_name in varchar2 default fnd_api.g_miss_char,
p_task_status_id in number default fnd_api.g_miss_num,
p_task_priority_name in varchar2 default fnd_api.g_miss_char,
p_task_priority_id in number default fnd_api.g_miss_num,
p_owner_type_name in varchar2 default fnd_api.g_miss_char,
p_owner_type_code in varchar2 default fnd_api.g_miss_char,
p_owner_id in number default fnd_api.g_miss_num,
p_owner_territory_id in number default fnd_api.g_miss_num,
p_assigned_by_name in varchar2 default fnd_api.g_miss_char,
p_assigned_by_id in number default fnd_api.g_miss_num,
p_customer_number in varchar2 default fnd_api.g_miss_char,
p_customer_id in number default fnd_api.g_miss_num,
p_cust_account_number in varchar2 default fnd_api.g_miss_char,
p_cust_account_id in number default fnd_api.g_miss_num,
p_address_id in number default fnd_api.g_miss_num,
p_address_number in varchar2 default fnd_api.g_miss_char,
p_planned_start_date in date default fnd_api.g_miss_date,
p_planned_end_date in date default fnd_api.g_miss_date,
p_scheduled_start_date in date default fnd_api.g_miss_date,
p_scheduled_end_date in date default fnd_api.g_miss_date,
p_actual_start_date in date default fnd_api.g_miss_date,
p_actual_end_date in date default fnd_api.g_miss_date,
p_timezone_id in number default fnd_api.g_miss_num,
p_timezone_name in varchar2 default fnd_api.g_miss_char,
p_source_object_type_code in varchar2 default fnd_api.g_miss_char,

p_source_object_id in number default fnd_api.g_miss_num,

p_source_object_name in varchar2 default fnd_api.g_miss_char,
p_duration in number default fnd_api.g_miss_num,
p_duration_uom in varchar2 default fnd_api.g_miss_char,
p_planned_effort in number default fnd_api.g_miss_num,
p_planned_effort_uom in varchar2 default fnd_api.g_miss_char,
p_actual_effort in number default fnd_api.g_miss_num,
p_actual_effort_uom in varchar2 default fnd_api.g_miss_char,
p_percentage_complete in number default fnd_api.g_miss_num,
p_reason_code in varchar2 default fnd_api.g_miss_char,
p_private_flag in varchar2 default fnd_api.g_miss_char,
p_publish_flag in varchar2 default fnd_api.g_miss_char,
p_restrict_closure_flag in varchar2 default fnd_api.g_miss_char,
p_multi_booked_flag in varchar2 default fnd_api.g_miss_char,
p_milestone_flag in varchar2 default fnd_api.g_miss_char,
p_holiday_flag in varchar2 default fnd_api.g_miss_char,
p_billable_flag in varchar2 default fnd_api.g_miss_char,
p_bound_mode_code in varchar2 default fnd_api.g_miss_char,
p_soft_bound_flag in varchar2 default fnd_api.g_miss_char,
p_workflow_process_id in number default fnd_api.g_miss_num,
p_notification_flag in varchar2 default fnd_api.g_miss_char,
p_notification_period in number default fnd_api.g_miss_num,
p_notification_period_uom in varchar2 default fnd_api.g_miss_char,
p_alarm_start in number default fnd_api.g_miss_num,
p_alarm_start_uom in varchar2 default fnd_api.g_miss_char,
p_alarm_on in varchar2 default fnd_api.g_miss_char,
p_alarm_count in number default fnd_api.g_miss_num,
p_alarm_fired_count in number default fnd_api.g_miss_num,
p_alarm_interval in number default fnd_api.g_miss_num,
p_alarm_interval_uom in varchar2 default fnd_api.g_miss_char,
p_palm_flag in varchar2 default fnd_api.g_miss_char,
p_wince_flag in varchar2 default fnd_api.g_miss_char,
p_laptop_flag in varchar2 default fnd_api.g_miss_char,
p_device1_flag in varchar2 default fnd_api.g_miss_char,
p_costs in number default fnd_api.g_miss_num,
p_currency_code in varchar2 default fnd_api.g_miss_char,
p_escalation_level in varchar2 default fnd_api.g_miss_char,
p_attribute1 in varchar2 default jtf_task_utl.g_miss_char,


p_attribute_category in varchar2 default jtf_task_utl.g_miss_char
p_date_selected in varchar2 default jtf_task_utl.g_miss_char,
p_category_id in number default jtf_task_utl.g_miss_number,
p_show_on_calendar in varchar2 default jtf_task_utl.g_miss_char,
p_owner_status_id in number default jtf_task_utl.g_miss_number,
p_parent_task_id in number default jtf_task_utl.g_miss_number,
p_parent_task_number in varchar2 default jtf_task_utl.g_miss_char
);
Current Version
1.0
The following tables describes the IN parameters associated with this API.
Table 3–6 Update_Task IN Parameters

page 1-3.
page 1-3.
page 1-3.
p_object_ NUMBER Yes This parameter is for internal use only.
version_number Do not modify in any way.


p_task_id NUMBER No This is the unique task identifier
(Primary Key).
passed as an OUT parameter x_task_id.
p_task_number VARCHAR2 No This defines the task number.
p_task_name VARCHAR2 Yes This defines the task name.
p_task_type_ VARCHAR2 No This defines the task type name.
name
p_task_type_id NUMBER Yes This defines the task type identifier.
p_description VARCHAR2 No This is the description of the task.
p_task_status_ VARCHAR2 No This is the task status name.
name
p_task_status_id NUMBER No This is the unique task status identifier.
p_task_priority_ VARCHAR2 No Currently not supported.
name
p_task_priority_ NUMBER No Task priority (Foreign Key to JTF_
id TASK_PRIORITIES).
p_owner_type_ VARCHAR2 No Currently not supported.
name
p_owner_type_ VARCHAR2 Yes Owner type of the task (Foreign Key to
code JTF_OBJECTS_VL for an object with a
usage of "Resources").
p_owner_id NUMBER Yes Owner of the task (resource ID of the
task owner. Foreign Key to JTF_RS_
RESOURCE_EXTNS_VL, JTF_RS_
GROUPS_VL, JTF_RS_TEAMS_VL
depending on the value of owner_type_
code).
p_owner_ NUMBER No Territory identifier of the owner.
territory_id
p_assigned_by_ VARCHAR2 No Currently not supported.
name
p_assigned_by_ NUMBER No User who assigned the task, (Foreign
id Key to FND_USER).


p_customer_ VARCHAR2 No Customer number (Foreign Key to hz_
number parties.party_number).
p_customer_id NUMBER No Customer identifier (Foreign Key to hz_
parties.party_id).
p_cust_account_ VARCHAR2 No Customer account number (Foreign Key
number to hz_cust_accounts.cust_account_
number).
p_cust_account_ NUMBER No Customer account identifier (Foreign
id Key to hz_cust_accounts.cust_account_id).
The customer account should belong to
the same customer who is specified for
the task.
p_address_id NUMBER No This is the address identifier.
p_address_ VARCHAR2 No Address number (Foreign key to hz_
number party_sites.party_site_number).
p_planned_start_ DATE No This defines the Planned start date.
date
p_planned_end_ DATE No This defines the Planned end date.
date
p_scheduled_ DATE No This defines the Scheduled start date.
start_date
p_scheduled_ DATE No This defines the Scheduled end date.
end_date
p_actual_start_ DATE No This defines the Actual start date.
date
p_actual_end_ DATE No This defines the Actual end date.
date
p_timezone_id NUMBER No Time zone identifier (timezone for the
planned, scheduled, and actual dates.)
Foreign Key to hz_timezones.timezone_id.
p_timezone_ VARCHAR2 No Currently not supported.
name


p_source_object_ VARCHAR2 No Only supported in Create Tasks.
type_code
p_source_object_ NUMBER No Only supported in Create Tasks.
id
p_source_object_ VARCHAR2 No Only supported in Create Tasks.
name
p_duration NUMBER No The duration of task.
p_duration_uom VARCHAR2 No Unit of measure for duration.
p_planned_effort NUMBER No This defines the planned effort.
p_planned_ VARCHAR2 No The unit of measure for planned effort.
effort_uom
p_actual_effort NUMBER No Actual amount of effort spent on a task
by all assignees.
p_actual_effort_ VARCHAR2 No Unit of measure for actual work.
uom
p_percentage_ NUMBER No Percentage completion of task.
complete
p_reason_code VARCHAR2 No Reason for rejecting a task, reassigning
a task, etc.
p_private_flag VARCHAR2 No Indicates whether the task is private or
public. Checks if the value is Y or N.
p_publish_flag VARCHAR2 No Indicates whether the task should be
published. Checks if the value is Y or N.
p_restrict_ VARCHAR2 No Indicates whether completing the task
closure_flag is necessary for the source object to be
deemed complete. Checks if the value is
Y or N.
p_multi_booked_ VARCHAR2 No Indicates whether the task can book
flag resources that are already assigned to
other tasks. Checks if the value is Y or
N.


p_milestone_flag VARCHAR2 No Indicates whether the task is a
milestone delivery date. Checks if the
value is Y or N.
p_holiday_flag VARCHAR2 No Indicates whether the task can be
performed on holidays. Checks if the
value is Y or N.
p_billable_flag VARCHAR2 No Indicates whether the task is billable.
Checks if the value is Y or N.
p_bound_mode_ VARCHAR2 No For internal use only.
code
p_soft_bound_ VARCHAR2 No For internal use only.
flag
p_workflow_ NUMBER No Identifier of last workflow process
process_id launched for this task.
p_notification_ VARCHAR2 No Flag indicating whether notification
flag workflow will be automatically
launched.
p_notification_ NUMBER No Time before the scheduled start date
period that a notification is sent to the
assignees.
p_notification_ VARCHAR2 No Unit of measure for notification period.
period_uom
p_alarm_start NUMBER No Indicates when the first alarm should be
fired. This parameter is currently not
supported.
p_alarm_start_ VARCHAR2 No The unit of measure for alarm_start. This
uom parameter is currently not supported.
p_alarm_on VARCHAR2 No Indicates whether the alarm is on. This
p_alarm_count NUMBER No Total number of alarms to fire. This
p_alarm_fired_ NUMBER No Number of times the alarm has been
count fired.
p_alarm_interval NUMBER No Alarm interval. This parameter is
currently not supported.


p_alarm_ VARCHAR2 No Unit of measure for alarm interval. This
interval_uom parameter is currently not supported.
p_palm_flag VARCHAR2 No Used by mobile devices. Checks if the
value is Y or N.
p_wince_flag VARCHAR2 No Used by mobile devices. Checks if the
value is Y or N.
p_laptop_flag VARCHAR2 No Used by mobile devices. Checks if the
value is Y or N.
value is Y or N.
value is Y or N.
value is Y or N.
p_costs NUMBER No For internal use only.
p_currency_code VARCHAR2 No For internal use only.
p_escalation_ VARCHAR2 No Escalation level. This parameter is not
level used for the Task Module.
p_attribute1 VARCHAR2 No Descriptive flexfield segment column.


category column.
p_date_selected VARCHAR2 No This date is copied from the task profile
option and copied to the Calendar Start
date. Valid values include Planned,
Scheduled, or Actual.
p_category_id NUMBER No Task Category ID
p_owner_status_ NUMBER Yes The status of the task level.
id
p_parent_task_id NUMBER No Identifier for the parent task.
p_parent_task_ VARCHAR2 No The parent task number.
number
Table 3–7 Update_Task OUT Parameters

3.2.4 Delete_Task
This procedure soft deletes a task with the given specifications. It marks the task as
deleted but does not physically remove the record from the table. If the task is
recurring, then all the future tasks can be deleted by setting the value of the
parameter p_delete_future_recurrences to fnd_api.g_true.

PROCEDURE delete_task
(
p_object_version_number in number,
p_task_number in varchar2 default null,
p_delete_future_recurrences in varchar2 default fnd_api.g_false,
);
Current Version
1.0
Table 3–8 Delete_Task IN Parameters

page 1-3.
page 1-3.
page 1-3.
p_object_ NUMBER No This parameter is for internal use only.
p_task_id NUMBER No Unique task identifier (Primary Key).
passed as an out parameter x_task_id.

Package JTF_TASKS_ASSIGNMENTS_PUB
Table 3–8 Delete_Task IN Parameters

p_delete_future_ VARCHAR2 No Used for recurring tasks. If the value of
recurrences the parameter is set to: fnd_api.g_true,
then all the future recurring tasks are
deleted.
Table 3–9 Delete_Task OUT Parameters

3.3 Package JTF_TASKS_ASSIGNMENTS_PUB

The Task Assignment APIs contains the following APIs:
■ Create_Task_Assignment
■ Update_Task_Assignment
■ Delete_Task_Assignment

The following data structure is used in the JTF_TASKS_ASSIGNMENTS_PUB API.
3.3.1.1 Task Assignments Record Type

The JTF_TASK_ASSIGNMENTS_REC creates the assignment details for a given
task.
TYPE task_assignments_rec IS RECORD (
task_assignment_id number,
object_version_number number,
task_id number,
resource_type_code varchar2(30),
resource_id number,
assignment_status_id number,
actual_effort number,

resource_territory_id number,
actual_effort_uom varchar2(3),
schedule_flag varchar2(1),
alarm_type_code varchar2(30),
alarm_contact varchar2(200),
shift_construct_id number,
sched_travel_distance number,
sched_travel_duration number,
sched_travel_duration_uom varchar2(3),
actual_travel_distance number,
actual_travel_duration number,
actual_travel_duration_uom varchar2(3),
actual_start_date date,
actual_end_date date,
palm_flag varchar2(1),
wince_flag varchar2(1),
laptop_flag varchar2(1),
device1_flag varchar2(1),
attribute_category varchar2(30),
show_on_calendar varchar2(1),
category_id number
);
3.3.2 Create_Task_Assignment
This procedure creates a task assignment for a given task with the following
specifications. Each task has a single owner, however, the task can have multiple

assignees. For each resource assigned to the task, the actual effort can be specified.
The task identifier or the task number for which the assignments are being created
must be specified.
PROCEDURE create_task_assignment
(
p_task_assignment_id in number default null,
p_task_name in varchar2, default null,
p_resource_type_code in varchar2,
p_resource_id in number,
p_resource_name in varchar2 default null,
p_actual_effort in number default null,
p_actual_effort_uom in varchar2 default null,
p_schedule_flag in varchar2 default null,
p_alarm_type_code in varchar2 default null,
p_alarm_contact in varchar2 default null,
p_sched_travel_distance in number default null,
p_sched_travel_duration in number default null,
p_sched_travel_duration_uom in varchar2 default null,
p_actual_travel_distance in number default null,
p_actual_travel_duration in number default null,
p_actual_travel_duration_uom in varchar2 default null,
p_actual_start_date in date default null,
p_actual_end_date in date default null,
p_palm_flag in varchar2 default null,
p_wince_flag in varchar2 default null,
p_laptop_flag in varchar2 default null,
p_resource_territory_id in number, default null,
p_assignment_status_id in number,
p_shift_construct_id in number default null,
x_task_assignment_id out number,


p_attribute_category in varchar2 default null
p_show_on_calendar in varchar2 default jtf_task_utl.g_yes_char,
p_category_id in number default null,
);
Current Version
1.0
Table 3–10 Create_Task_Assignment IN Parameters

page 1-3.
page 1-3.
page 1-3.
p_task_ NUMBER Yes For internal use only.
assignment_id
p_task_id NUMBER Yes The is the unique task identifier
(Primary Key).


p_task_name VARCHAR2 No This defines the task name.
p_resource_ VARCHAR2 Yes Assignee type of the task.
type_code
(Foreign Key to JTF_OBJECTS_VL for a
object with a usage of “Resources”).
p_resource_id NUMBER Yes Assignee of the task.
Resource identifier of the task owner.
(Foreign Key to JTF_RS_RESOURCE_
EXTNS_VL, JTF_RS_GROUPS_VL, JTF_
RS_TEAMS_VL depending on the value
of resource_type_code).
p_resource_name VARCHAR2 No This defines the resource name. Not
supported.
p_actual_effort NUMBER No Actual amount of effort spent on a task
by the assignees.
p_actual_effort_ VARCHAR2 No Unit of measure for actual work.
uom
p_schedule_flag VARCHAR2 No Indicates whether the resource should
be scheduled by the Scheduler.
The value must be Y, N, or NULL.
p_alarm_type_ VARCHAR2 No A lookup code that indicates how
code alarms should be sent to the resource.
For example, e-mail, pager, phone. Not
supported.
p_alarm_contact VARCHAR2 No Contact information for sending alarms.
This field may store e-mail address,
pager number, or phone number. Not
supported.
p_sched_travel_ NUMBER No Scheduled travel distance. Not
distance supported.
p_sched_travel_ NUMBER No Scheduled travel duration. Not
duration supported.
p_sched_travel_ VARCHAR2 No Unit of measure for scheduled travel
duration_uom duration. Not supported.
p_actual_travel_ NUMBER No Actual travel duration. Not supported.
distance


p_actual_travel_ NUMBER No Actual travel duration. Not supported.
duration
p_actual_travel_ VARCHAR2 No Unit of measure for actual travel
duration_uom duration. Not supported.
p_actual_start_ DATE No This defines the actual start date.
date
p_actual_end_ DATE No This defines the actual end date.
date
p_palm_flag VARCHAR2 No Used by mobile devices. Not supported.
p_wince_flag VARCHAR2 No Used by mobile devices. Not supported.
p_laptop_flag VARCHAR2 No Used by mobile devices. Not supported.
p_device1_flag VARCHAR2 No Used by mobile devices. Not supported.
p_resource_ NUMBER No Currently not supported.
territory_id
p_assignment_ NUMBER No Status identifier of the assignee.
status_id
(Foreign Key to JTF_TASK_STATUSES_
VL).
p_shift_ NUMBER No Shift construct identifier for the
construct_id assignment.


category column.
p_enable_ VARCHAR2 No Determines whether or not to send
N.
p_abort_ VARCHAR2 No Determines whether or not to abort the
value is Y or N.
Table 3–11 Create_Task_Assignment OUT Parameters

x_task_ NUMBER This is the unique task assignment identifier.
assignment_id

3.3.3 Update_Task_Assignment
This procedure updates a task assignment for a given task. The resource_ type_code
parameter indicates the type of resource. Resource_id indicates an actual identifier.
For each resource assigned to the task, the actual effort can be specified. The task
assignment identifier must be specified.
PROCEDURE update_task_assignment
(
p_task_assignment_id in number,
p_task_id in number default fnd_api.g_miss_num,
p_task_number in varchar2 default fnd_api.g_miss_char,
p_task_name in varchar2 default fnd_api.g_miss_char,
p_resource_type_code in varchar2 default fnd_api.g_miss_char,
p_resource_id in number default fnd_api.g_miss_num,
p_resource_name in varchar2 default fnd_api.g_miss_char,
p_actual_effort in number default fnd_api.g_miss_num,
p_actual_effort_uom in varchar2 default fnd_api.g_miss_char,
p_schedule_flag in varchar2 default fnd_api.g_miss_char,
p_alarm_type_code in varchar2 default fnd_api.g_miss_char,
p_alarm_contact in varchar2 default fnd_api.g_miss_char,
p_sched_travel_distance in number default fnd_api.g_miss_num,
p_sched_travel_duration in number default fnd_api.g_miss_num,
p_sched_travel_duration_uom in varchar2 default fnd_api.g_miss_char,
p_actual_travel_distance in number default fnd_api.g_miss_num,
p_actual_travel_duration in number default fnd_api.g_miss_num,
p_actual_travel_duration_uom in varchar2 default fnd_api.g_miss_char,
p_actual_start_date in date default fnd_api.g_miss_date,
p_actual_end_date in date default fnd_api.g_miss_date,
p_palm_flag in varchar2 default fnd_api.g_miss_char,
p_wince_flag in varchar2 default fnd_api.g_miss_char,
p_laptop_flag in varchar2 default fnd_api.g_miss_char,
p_resource_territory_id in number default fnd_api.g_miss_num,
p_assignment_status_id in number default fnd_api.g_miss_num,
p_shift_construct_id in number default fnd_api.g_miss_num,


p_show_on_calendar in varchar2 default jtf_task_utl.g_miss_char,
p_category_id in number default jtf_task_utl.g_miss_number,
);
Current Version
1.0
Table 3–12 Update_Task_Assignment IN Parameters

page 1-3.
page 1-3.
page 1-3.


p_task_ NUMBER No This is the unique task assignment
assignment_id identifier.
p_task_id NUMBER No This is the unique task identifier
(Primary Key).
p_task_name VARCHAR2 No This defines the task name.
p_resource_ VARCHAR2 No This is the resource type identifier.
type_code
p_resource_id NUMBER No This is the resource identifier.
p_resource_name VARCHAR2 No This defines the resource name. Not
supported.
p_actual_effort NUMBER No The actual amount of effort spent on a
task by all assignees.
p_actual_effort_ VARCHAR2 No The unit of measure for actual work.
uom
p_schedule_flag VARCHAR2 No Indicates whether the resource should
be scheduled by the Scheduler.
p_alarm_type_ VARCHAR2 No A lookup code that indicates how
code alarms should be sent to the resource.
For example, e-mail, pager, phone.
p_alarm_contact VARCHAR2 No Contact information for sending alarms.
This field may store an e-mail address,
pager number, or phone number.
p_sched_travel_ NUMBER No This defines the scheduled travel
distance distance.
p_sched_travel_ NUMBER No This defines the scheduled travel
duration duration.
p_sched_travel_ VARCHAR2 No This defines the unit of measure for
duration_uom scheduled travel duration.
p_actual_travel_ NUMBER No This defines the actual travel duration.
distance
p_actual_travel_ NUMBER No This defines the actual travel duration.
duration


p_actual_travel_ VARCHAR2 No This defines the unit of measure for
duration_uom actual travel duration.
p_actual_start_ DATE No This defines the actual start date.
date
p_actual_end_ DATE No This defines the actual end date.
date
p_palm_flag VARCHAR2 No Used by mobile devices.
p_wince_flag VARCHAR2 No Used by mobile devices.
p_laptop_flag VARCHAR2 No Used by mobile devices.
p_device1_flag VARCHAR2 No Used by mobile devices.
p_resource_ NUMBER No Currently not supported.
territory_id
p_assignment_ NUMBER No The status identifier of the assignee.
status_id
p_shift_ NUMBER No The shift construct identifier for the
construct_id assignment.


category column.
N.
value is Y or N.
Table 3–13 Update_Task_Assignment OUT Parameters

Parameter Data Type Descriptions and Validations
3.3.4 Delete_Task_Assignment
This procedure deletes a task assignment for a given task. The task assignment must
be specified.
PROCEDURE delete_task_assignment
(

p_task_assignment_id in number,
);
Current Version
1.0
Table 3–14 Delete_Task_Assignment IN Parameters

page 1-3.
page 1-3.
page 1-3.
p_task_ NUMBER No This is the unique task assignment
assignment_id identifier.
N.
value is Y or N.

Package JTF_TASK_REFERENCES_PUB
Table 3–15 Delete_Task_Assignment OUT Parameters

3.4 Package JTF_TASK_REFERENCES_PUB

The JTF_Task_References_Pub package contains the following APIs:
■ Create_References
■ Update_References
■ Delete_References

The following data structure is used in the JTF_TASK_REFERENCES_PUB API.
3.4.1.1 References Record Type

The REFERENCES_REC creates the reference for a given task.
TYPE references_rec IS RECORD
(
task_reference_id number,
task_id number,
object_type_code varchar2(30),
object_name varchar2(80),
object_id number,
object_details varchar2(2000),
reference_code varchar2(30),

attribute_category varchar2(30),
usage varchar2(2000),
object_version_number number
);
3.4.2 Create_References
This API establishes references to a task. For example, a task created for a service
request can establish reference to an inventory part number using references. The
following information applies to this API:
■ Every task is associated with a source. It can also be associated with multiple
references.
■ Task_id or task_number must be passed.
■ If the API executes successfully, then the output parameter is task_reference_id.
PROCEDURE create_references
(
p_object_type_code in varchar2 default null,
p_object_name in varchar2,
p_object_id in number,
p_object_details in varchar2 default null,
p_reference_code in varchar2 default null,
p_usage in varchar2 default null,
x_task_reference_id out number,


p_attribute_category in varchar2 default null
);
Current Version
1.0
Table 3–16 Create_References IN Parameters

page 1-3.
page 1-3.
page 1-3.
p_task_id NUMBER Yes This is the unique task identifier
(Primary Key).
p_object_type_ VARCHAR2 No Reference object type code (Foreign Key
code to JTF_OBJECTS_VL for objects with a
usage of “Task”.)


p_object_name VARCHAR2 No This is the name of reference object.
code.
p_object_id NUMBER No This defines the internal identifier of
reference object.
jtf_objects_vl for the object_type_code.
p_object_details VARCHAR2 No Additional information of the reference
object.
p_reference_code VARCHAR2 No Lookup code indicating the context of
the reference.
Not supported and not used in the
context of the Tasks module.
p_usage VARCHAR2 No User comment on the usage of the
reference.


category column.
Table 3–17 Create_References OUT Parameters

x_task_ NUMBER This is the unique task reference identifier.
reference_id
3.4.3 Update_References
This API is used to update references to a task.
Note: Task_reference_id must be an input parameter.
PROCEDURE update_references
(
p_task_reference_id in number,
p_object_type_code in varchar2 default fnd_api.g_miss_char,
p_object_name in varchar2 default fnd_api.g_miss_char,
p_object_id in number default fnd_api.g_miss_num,
p_object_details in varchar2 default fnd_api.g_miss_char,
p_reference_code in varchar2 default fnd_api.g_miss_char,
p_usage in varchar2 default fnd_api.g_miss_char,


);
Current Version
1.0
Table 3–18 Update_References IN Parameters

page 1-3.
page 1-3.
page 1-3.
p_task_ NUMBER Yes Unique task reference identifier.
reference_id
p_object_type_ VARCHAR2 No Reference object type code (Foreign Key
code to JTF_TASK_OBJECT_TYPES).

Table 3–18 Update_References IN Parameters

p_object_name VARCHAR2 No This defines the name of the reference
object.
p_object_id NUMBER No This is the internal identifier of
reference object.
p_object_details VARCHAR2 No This provides additional information
for the reference object.
p_reference_code VARCHAR2 No Lookup code indicating the context of
the reference.
p_usage VARCHAR2 No User comment on the usage of the
reference.
category column.

Table 3–19 Update_References OUT Parameters

3.4.4 Delete_References
This API is used to delete references to a task.
Note: Task_reference_id must be an input parameter.
PROCEDURE delete_references
(
p_task_reference_id in number default null,
x_msg_count out number
);
Current Version
1.0
Table 3–20 Delete_References IN Parameters

page 1-3.
page 1-3.

Table 3–20 Delete_References IN Parameters

page 1-3.
p_task_ NUMBER Yes Unique task reference identifier.
reference_id
Table 3–21 Delete_References OUT Parameters


The APIs contained in the Task Manager public packages generate messages and
notifications as needed. Some of these messages are common to all of the Task
Manager APIs and others are generated by APIs in specific Task Manager packages.
Both types of messages are detailed in the following sections.
■ Common Messages
■ JTF_TASKS_PUB

it is provided.

3.5.1 Common Messages

The following table lists the messages and notifications generated by many of the
APIs contained in Task Manager public packages.
Table 3–22 Common Task API Messages

N/A E JTF_TASK_DISTANCE_UNITS Quantity for p_distance_tag is invalid.
N/A E JTF_TASK_INVALID_CONTACT Contacts details are invalid.
N/A E JTF_TASK_INVALID_DEFAULT_ Default owner for the task is not setup correctly.
OWNER
N/A E JTF_TASK_INVALID_PHONE_ID Phone details are invalid. (Contact point
identifier = p_phone_id).
N/A E JTF_TASK_MISSING_CONTACT Contact details are missing.
N/A E JTF_TASK_MISSING_PHONE Phone details are missing.
N/A E JTF_TASK_MISSING_USER_MAPPING User is not mapped to a resource.
210000 E JTF_TASK_MISSING_UOM Unit of measure for p_tag should be specified.
210001 E JTF_TASK_INVALID_PRIORITY_ID Task Priority p_task_priority_id is either
disabled or invalid.
210002 E JTF_TASK_INVALID_PRIORITY_ Task Priority p_task_priority_name is either
NAME disabled or invalid.
210003 E JTF_TASK_INVALID_TYPE_ID Task Type p_task_type_id is either disabled or
invalid.
210004 E JTF_TASK_INVALID_UOM Unit of Measure p_uom_code is either disabled
or invalid.
210005 E JTF_TASK_INVALID_DEPENDS_ Currency Code p_dependency_code is either
CODE disabled or invalid.
210006 E JTF_TASK_INVALID_TEMP_NUMBER Task Template p_task_template_number is
invalid.
210008 E JTF_TASK_INVALID_TEMP_ID Task Template p_task_template_id is invalid.
210012 E JTF_TASK_INVALID_CUST_ACCT_ID Customer Account p_cust_account_id is invalid
or disabled.
210013 E JTF_TASK_INVALID_PARTY_ID Customer p_party_id is invalid or disabled.
210014 E JTF_TASK_INVALID_PARTY_ Customer party_number is invalid or disabled.
NUMBER


210015 E JTF_TASK_INVALID_SITE_ID Address p_party_site_id is invalid or disabled.
210016 E JTF_TASK_INVALID_SITE_NUMBER Address p_party_site_number is invalid or
disabled.
210018 E JTF_TASK_INVALID_FLAG P_flag_name must be Yes or No.
210020 E JTF_TASK_INVALID_DEPENDS_ID Dependency p_dependency_id does not exist.
210021 E JTF_TASK_INVALID_ASSIGNED_ User p_assigned_by_name is invalid or disabled.
NAME
210022 E JTF_TASK_INVALID_CURRENCY_ Currency p_currency_code is invalid or disabled.
CODE
210023 E JTF_TASK_MISSING_CURRENCY_ P_cost, currency code should be present.
CODE
Cause: both cost currency code should be
present.
210024 E JTF_TASK_MISSING_COST For p_currency_code, cost should be present.
Cause: both cost currency code should be
present.
210026 E JTF_TASK_INVALID_TIMEZONE_ Timezone for p_timezone_name is either
NAME disabled or invalid.
210027 E JTF_TASK_INVALID_TIMEZONE_ID Timezone for p_timezone_id is either disabled or
invalid.
210029 U JTF_TASK_UNKNOWN_ERROR Error text.
210031 E JTF_TASK_INVALID_OBJECT_NAME P_object_type_code p_object_name is either
210032 E JTF_TASK_INVALID_OBJECT_CODE P_object_code is either disabled or invalid.
210034 E JTF_TASK_INVALID_QUANTITY Value for p_tag should be greater than 0.
210035 E JTF_TASK_MISSING_QUANTITY Quantity for p_tag should be specified.
210037 E JTF_TASK_INVALID_STATUS_NAME Task status p_task_status_name is either
210039 E JTF_TASK_INVALID_TYPE_NAME Task type p_task_type_name is either disabled or
invalid.
210041 E JTF_TASK_INVALID_STATUS_ID Status p_task_status_id is either disabled or
invalid.
210046 E JTF_TASK_INVALID_DATES P_date_tag start date cannot be greater than p_
date_tag end date.


210047 E JTF_TASK_INVALID_SOURCE_DTLS Invalid source object details provided.
210048 E JTF_TASK_INVALID_TEMP_GRP_ Task template group p_task_temp_group_name
NAME is either disabled or invalid.
210049 E JTF_TASK_INVALID_TEMP_GRP_ID Task template group p_task_template_group_id
is either disabled or invalid.
210051 E JTF_TASK_INVALID_TASK_ID Task p_task_id is invalid.
210052 E JTF_TASK_INVALID_TASK_NUMBER Task number p_task_number is invalid.
210055 E JTF_TASK_MISSING_TASK Task is missing.
210056 E JTF_TASK_INVALID_DATE_TYPE_ID Date type p_date_type_id is invalid.
210065 E JTF_TASK_INVALID_TERR_ID Territory p_terr_id is disabled or invalid.
210066 E JTF_TASK_INVALID_TERR_NAME Territory is disabled or invalid.
210067 E JTF_TASK_INVALID_ESC_DTLS Invalid escalation details.
210068 E JTF_TASK_INVALID_OWNER_ID Owner p_owner_id is invalid.
210069 E JTF_TASK_PARENT_TYPE_CODE Parent task should have the same source
document types as the given task.
210069 E JTF_TASK_PARENT_TYPE_CODE Parent task should have the same source
document types as the given task.
210070 E JTF_TASK_PARENT Parent task does not have the same source object
details as the given task.
210118 E JTF_TASK_MISSING_RETURN_ Return status from internal API hook is missing.
STATUS
210120 E JTF_TASK_MISSING_LOOKUP Lookup code (p_lookup_code) is not defined for
lookup type p_lookup_type.

3.5.2 JTF_TASK_ASSIGNMENTS_PUB
The following table lists the messages and notifications generated by the APIs
contained in the JTF_TASK_ASSIGNMENTS_PUB package.
Table 3–23 JTF_TASK_ASSIGNMENTS_PUB API Messages

210082 E JTF_TASK_INV_RES_TYP_COD Resource type code is invalid or disabled.
This feature is currently not enabled in the API.
This error should never occur.
210080 E JTF_TASK_NULL_RES_ID Resource identifier is missing.
JTF_TASK_MISSING_TASK_STATUS Task status is missing or invalid.
210085 E JTF_TASK_INV_ALA_TYPE Alarm type code is invalid or disabled.
210086 E JTF_TASK_INV_ALA_CON Alarm contact is invalid or disabled.
This feature is currently not enabled in the API.
This error should never occur.
210117 E JTF_TASK_RESOURCE_LOCKED Resource is locked or deleted.
210113 E JTF_TASK_NULL_TK_ASS Task assignment is missing.
210114 E JTF_TASK_INV_TK_ASS Task assignment identifier is invalid or missing.
210115 E JTF_TASK_DELETING_TK_ASS Error deleting task assignment.
3.5.3 JTF_TASK_REFERENCES_PUB
contained in the JTF_TASK_REFERENCES_PUB package.
Table 3–24 JTF_TASK_REFERENCES_PUB API Messages

210025 E JTF_TASK_MISSING_OBJECT_NAME Object name is missing.
210028 E JTF_TASK_MISSING_OBJECT_CODE Source object type code is missing.

Table 3–24 JTF_TASK_REFERENCES_PUB API Messages

210031 E JTF_TASK_INVALID_OBJECT_NAME Object code object name is either disabled or
invalid.
210032 E JTF_TASK_INVALID_OBJECT_CODE Object code is either disabled or invalid.
210038 E JTF_TASK_INVALID_REFER Task reference identifier is invalid.
210042 E JTF_TASK_MISSING_REFER Task reference is missing.
210044 E JTF_TASK_INVALID_OBJECT_ID Object identifier is invalid.
210050 E JTF_TASK_INVALID_REFER_CODE Reference code is either disabled or invalid.
210053 E JTF_TASK_INVALID_REFER_DETAILS Invalid reference details.
3.5.4 JTF_TASKS_PUB
contained in the JTF_TASKS_PUB package.
Table 3–25 JTF_TASK_ API Messages

21002 E JTF_TASK_INVALID_PRIORITY_ Task priority is either disabled or invalid.
NAME
210007 E JTF_TASK_MISSING_TEMP_GRP Task template group is missing.
210011 E JTF_TASK_INVALID_CUST_ACCT_ Customer account number is disabled or invalid.
NUM
210021 E JTF_TASK_INVALID_ASSIGNED_ User assigned by name is invalid or disabled.
NAME
210029 U JTF_TASK_UNKNOWN_ERROR Returns the unhandled error text.
210036 E JTF_TASK_MISSING_STATUS Task status is missing.
210040 E JTF_TASK_MISSING_TYPE Task type is missing.
E JTF_TASK_INVALID_CUST_ACCT_ The customer account number is not valid.
NUM

Sample Code
Table 3–25 JTF_TASK_ API Messages

210046 E JTF_TASK_INVALID_DATES Date start date cannot be greater than date end
date.
210051 E JTF_TASK_INVALID_TASK_ID Task identifier is invalid.
210052 E JTF_TASK_INVALID_TASK_NUMBER Task number is invalid.
210060 E JTF_TASK_CONVERTING_NUMBER Error converting template number to task
number.
210098 E JTF_TK_INV_QRY_NXT Invalid value query or next code can be Q or N.
210099 E JTF_TK_INV_SHOW_ALL Invalid value show all can be Y or N.
210100 E JTF_TK_NULL_STRT_PTR Start record number cannot be NULL.
210101 E JTF_TK_NULL_REC_WANT Number of records wanted cannot be NULL.
210103 E JTF_TASK_INV_TK_NAME Invalid task name.
210104 E JTF_TK_OBJECT_TYPE_ID_RQD Both object identifier and object type code are
required if one is present.
210105 E JTF_TK_QRY_NXT_INV_QRY_TYP Invalid query type.
210106 E JTF_TK_QRY_NXT_INV_DT_TYPE Invalid date type.
210107 E JTF_TK_QRY_NXT_NUL_ASGND_BY Assigned by identifier is NULL.
210108 E JTF_TK_QRY_NXT_NUL_ Owner identifier or type is NULL.
210109 E JTF_TK_EXP_FILE_NAME_NULL Output file name cannot be NULL.
210110 E JTF_TK_EXP_TABLE_EMPTY Task table input table is NULL.
210111 E JTF_TK_QRY_NXT_INV_STRT_END_ Invalid value for start or end date query
DT parameter.
210112 E JTF_TK_NO_DATE Created date field for current task identifier is
NULL.
3.6 Sample Code

This section contains SQL scripts that call the Task Manager public APIs stored in
the following packages and insert values as required:

Sample Code
■ JTF_TASKS_PUB
3.6.1 Package JTF_TASKS_PUB

The SQL scripts in this section create a task by calling the Create_Task API
contained in the JTF_TASKS_PUB package and by providing them with the
required values.
Create_Task
This script calls the Create_Task API and creates tasks with the following
information.
Table 3–26 Create_Task API Sample Code Variables

p_user_name Login user name is entered by a user.
p_task_name Task name is entered by a user.
p_task_type The type of task is entered by a user, such as "Meeting", or
"Lunch".
p_task_priority Task priority is entered by a user, such as "High",
"Medium", or "Low".
p_task_status Task status is entered by a user, such as "Open".
p_show_on_cal A flag used to determine if the task will be shown in the
calendar view.
p_start_date The planned start date is entered by a user.
p_end_date The planned end date is entered by a user.
set serveroutput on
accept p_user_name prompt 'Enter user name : '

accept p_task_name prompt 'Enter task name : '
accept p_task_type prompt 'Enter task type name (Default=Meeting): '
accept p_priority prompt 'Enter priority name (Default=Medium) : '
accept p_task_status prompt 'Enter task status name (Default=Open) : '
accept p_show_on_cal prompt 'Enter Y if you want to show this task on calendar view
(Default=N) : '

Sample Code
accept p_start_date prompt 'Enter task start date (Format=MMDDYYYY HH24MI) : '
accept p_end_date prompt 'Enter task end date (Format=MMDDYYYY HH24MI) : '
declare
l_user_name fnd_user.user_name%TYPE := upper('&p_user_name');
l_task_name jtf_tasks_tl.task_name%TYPE := '&p_task_name';
l_task_type jtf_task_types_tl.name%TYPE := NVL('&p_task_type_name','Meeting');
l_task_priority jtf_task_priorities_tl.name%TYPE := NVL('&p_priority', 'Medium');
l_task_status jtf_task_statuses_tl.name%TYPE := NVL('&p_task_status','Open');
l_show_on_cal jtf_task_all_assignments.show_on_calendar%TYPE := NVL(upper('&p_show_on_
cal'),'N');
l_planned_start_date DATE := NVL(TO_DATE('&p_start_date','MMDDYYYY HH24MI'),SYSDATE);
l_planned_end_date DATE := NVL(TO_DATE('&p_end_date','MMDDYYYY HH24MI'),SYSDATE);
cursor c_login_user (b_user_name VARCHAR2) is

select user_id
from fnd_user
where user_name = b_user_name;
cursor c_owner (b_user_id NUMBER) is

select resource_id
from jtf_rs_emp_dtls_vl r
where r.user_id = b_user_id;
cursor c_task_type (b_name VARCHAR2) is

select task_type_id
from jtf_task_types_tl
where name = b_name;
cursor c_task_status (b_status VARCHAR2) is

select task_status_id
from jtf_task_statuses_vl
where name = b_status
and task_status_flag = 'Y';
cursor c_task_priority (b_priority VARCHAR2) is

select task_priority_id
from jtf_task_priorities_tl
where name = b_priority;
l_user_id NUMBER;
l_resource_id NUMBER;
l_task_type_id NUMBER;
l_task_status_id NUMBER;
l_task_priority_id NUMBER;

Sample Code
l_task_id NUMBER;
l_return_status VARCHAR2(1);
l_msg_count NUMBER;
l_msg_data VARCHAR2(1000);
begin
dbms_output.put_line('-------------------------------------------');
open c_login_user(l_user_name);
fetch c_login_user into l_user_id;
if c_login_user%NOTFOUND then
close c_login_user;
raise_application_error(-20000,'User name '||l_user_name||' is not found.');
end if;
close c_login_user;
dbms_output.put_line('User Id : '||l_user_id);
open c_owner (l_user_id);

fetch c_owner into l_resource_id;
if c_owner%NOTFOUND then
close c_owner;
raise_application_error(-20000,'Resource for the user name '||l_user_name||' is not
found.');
end if;
close c_owner;
dbms_output.put_line('Owner Resource Id : '||l_resource_id);
open c_task_type (l_task_type);

fetch c_task_type into l_task_type_id;
if c_task_type%NOTFOUND then
close c_task_type;
raise_application_error(-20000,'Task type '||l_task_type||' is not found.');
end if;
close c_task_type;
open c_task_status(l_task_status);
fetch c_task_status into l_task_status_id;
if c_task_status%NOTFOUND then
close c_task_status;
raise_application_error(-20000,'Task status '||l_task_status||' is not found.');
end if;
close c_task_status;
open c_task_priority(l_task_priority);

Sample Code
fetch c_task_priority into l_task_priority_id;

if c_task_priority%NOTFOUND then
close c_task_priority;
raise_application_error(-20000,'Task status '||l_task_priority||' is not found.');
end if;
close c_task_priority;
fnd_global.apps_initialize(l_user_id, 0, 690);
jtf_tasks_pub.create_task(
p_api_version => 1.0 ,
p_init_msg_list => fnd_api.g_true,
p_commit => fnd_api.g_false,
p_task_name => l_task_name,
p_task_type_id => l_task_status_id,
p_task_status_id => l_task_type_id,
p_task_priority_id => l_task_priority_id,
p_owner_type_code => 'RS_EMPLOYEE',
p_owner_id => l_resource_id,
p_show_on_calendar => l_show_on_cal,
p_planned_start_date => l_planned_start_date,
p_planned_end_date => l_planned_end_date,
p_date_selected => 'P',
x_return_status => l_return_status,
x_msg_count => l_msg_count,
x_msg_data => l_msg_data,
x_task_id => l_task_id
);
IF l_return_status <> fnd_api.g_ret_sts_success THEN
IF l_msg_count > 0 THEN
l_msg_data := NULL;
FOR i IN 1..l_msg_count LOOP
l_msg_data := l_msg_data ||' '||fnd_msg_pub.get(1, 'F');
END LOOP;
fnd_message.set_encoded(l_msg_data);
dbms_output.put_line(l_msg_data);
END IF;
ROLLBACK;
ELSE
dbms_output.put_line('Task Id = '||l_task_id);
dbms_output.put_line('Return Status = '||l_return_status);
COMMIT;
END IF;
end;

Sample Code
3.6.2 Package JTF_TASK_ASSIGNMENTS_PUB

The SQL scripts in this section create a task assignment for a specific task by calling
the Create_Task_Assignment API contained in the JTF_TASK_ASSIGNMENTS_
PUB package and by providing them with the required values.
Create_Task_Assignment
This script calls the Create_Task_Assignment API and adds an assignee with the
following information.
Table 3–27 Create_Task_Assignment API Sample Code Variables

p_task_id Task ID is entered by a user.
p_emp_resource_id Resource ID for an employee is entered by a user.
p_show_on_cal A flag used to determine if the task will be shown in the
calendar view.
p_assignment_status Task assignment status is entered by a user.
set serveroutput on

accept p_task_id prompt 'Enter task id : '
accept p_emp_resource_id prompt 'Enter resource id for an employee : '
accept p_show_on_cal prompt 'Do you want to show this task on calendar view ? (Y or N) : '
accept p_assignment_status prompt 'Enter Assignment status name : '
declare
l_task_id jtf_tasks_b.task_id%TYPE := '&p_task_id';
l_emp_resource_id jtf_rs_emp_dtls_vl.resource_id%TYPE := '&p_emp_resource_id';
l_show_on_cal jtf_task_all_assignments.show_on_calendar%TYPE := NVL(upper('&p_show_
on_cal'),'N');
l_assignment_status jtf_task_statuses_vl.name%TYPE := NVL('&p_assignment_status',
'Accepted');

Sample Code

select user_id
from fnd_user
cursor c_assignee is
select resource_id
from jtf_rs_emp_dtls_vl r
where r.resource_id = l_emp_resource_id;
cursor c_assignment_status (b_status VARCHAR2) is

select task_status_id
from jtf_task_statuses_vl
where name = b_status
and assignment_status_flag = 'Y';
l_user_id NUMBER;
l_assignee_id NUMBER;
l_assignment_status_id NUMBER;
l_task_assignment_id NUMBER;
l_msg_count NUMBER;
begin
close c_login_user;
end if;
close c_login_user;
open c_assignee;
fetch c_assignee into l_assignee_id;
if c_assignee%NOTFOUND then
close c_assignee;
raise_application_error(-20000,'Employee resource id '||l_emp_resource_id||' is not
found.');
end if;
close c_assignee;

Sample Code
open c_assignment_status(l_assignment_status);
fetch c_assignment_status into l_assignment_status_id;
if c_assignment_status%NOTFOUND then
close c_assignment_status;
raise_application_error(-20000,'Assignment status '||l_assignment_status||' is not
found.');
end if;
close c_assignment_status;
jtf_task_assignments_pub.create_task_assignment(
p_api_version => 1.0,
p_task_assignment_id => NULL,
p_task_id => l_task_id,
p_resource_type_code => 'RS_EMPLOYEE',
p_resource_id => l_assignee_id,
p_assignment_status_id => l_assignment_status_id,
p_show_on_calendar => l_show_on_cal,
x_task_assignment_id => l_task_assignment_id
);
l_msg_data := NULL;
END LOOP;
END IF;
ROLLBACK;
ELSE
dbms_output.put_line('l_task_assignment_id = '||l_task_assignment_id);
COMMIT;
END IF;
end;
/

Sample Code
3.6.3 Package JTF_TASK_REFERENCES_PUB

The SQL scripts in this section create references to a specific task by calling the
Create_References API contained in the JTF_TASK_REFERENCES_PUB package
and by providing them with the required values.
Create_References
This script calls the Create_References API and creates a reference with the
following information.
Table 3–28 Create_References API Sample Code Variables

p_task_id The ID of the task which the reference is added to is entered
by a user.
p_source_object_type Source object type is entered by a user, such as "Party".
p_source_object_name Source object name is entered by a user, such as "Business
World".
p_source_object_id Source object ID is entered by a user, such as "1001".
set serveroutput on

accept p_task_id prompt 'Enter task id : '
accept p_source_object_type prompt 'Enter source object type (e.g. PARTY) : '
accept p_source_object_name prompt 'Enter source object name (Enter party name if object type is
PARTY): '
accept p_source_object_id prompt 'Enter source object id (Enter party id if object type is
PARTY): '
declare
l_task_id jtf_tasks_b.task_id%TYPE := '&p_task_id';
l_source_object_type jtf_tasks_b.source_object_type_code%TYPE := upper('&p_source_object_
type');
l_source_object_name jtf_tasks_b.source_object_name%TYPE := '&p_source_object_name';
l_source_object_id jtf_tasks_b.source_object_id%TYPE := '&p_source_object_id';

Sample Code
select user_id
from fnd_user
l_user_id NUMBER;
l_task_reference_id NUMBER;
l_msg_count NUMBER;
begin
close c_login_user;
end if;
close c_login_user;
jtf_task_references_pub.create_references(
p_api_version => 1.0,
p_task_id => l_task_id,
p_object_type_code => l_source_object_type,
p_object_name => l_source_object_name,
p_object_id => l_source_object_id,
x_task_reference_id => l_task_reference_id
);
l_msg_data := NULL;
END LOOP;

Sample Code
END IF;
ROLLBACK;
ELSE
dbms_output.put_line('l_task_reference_id = '||l_task_reference_id);
COMMIT;
END IF;
end;
/

4
Notes Public APIs
Notes are free-formed text, created by an agent, customer care or service

representative, or end user and attached to a business object. Applications in the
Oracle e-Business Suite use notes to help retain information about business objects,
such as directions, special instructions, and reminders. Notes are also used for
service requests, service quotes, marketing offerings, and tasks.
The following topics are discussed in this chapter:
■ Package JTF_NOTES_PUB
■ Sample Code
4.1 Package JTF_NOTES_PUB

All public procedures (APIs) relating to creating and updating notes are stored in
the JTF_NOTES_PUB package. There are two public Note APIs:
■ Create_Notes
■ Update_Notes
Notes Public APIs 4-1

Package JTF_NOTES_PUB

Package JTF_NOTES_PUB contain one data structure.
4.1.1.1 Record jtf_note_contexts_rec_type

The JTF_NOTE_CONTEXTS_REC is used to store information about the context (a
related business object) for the note. This record type is used to create both of the
following:
■ jtf_note_contexts_tab
■ jtf_note_contexts_tab_dflt
TYPE jtf_note_contexts_rec_type IS RECORD
( note_context_id NUMBER,
jtf_note_id NUMBER,
note_context_type VARCHAR2(240),
note_context_type_id NUMBER,
last_update_date DATE,
last_updated_by NUMBER(15),
creation_date DATE,
created_by NUMBER,
last_update_login NUMBER
);
These parameters have the same meaning as those defined for the individual Notes
APIs.
4.1.2 Notes Public APIs

The following table describes the public APIs which are discussed in this chapter.
Table 4–1 The Notes Public APIs

Create_Note Creates a note (record) and writes it to the database.
Update_Note Updates an existing note (record) and writes the updated
version to the database.
4.1.3 Note Source and Note Context

The following section details the relationship between both the note source and note
context and the JTF_NOTES_PUB API package.

4.1.3.1 Note Source

The note source is always required when using the JTF_NOTES_PUB API package.
The note source is a business object that owns the note. It is always one of the
following:
■ the creator of the note
■ the initiator of the note
■ the parent of the note
This could be a party, a service request, or an order, for example. In any case, the
note does not make sense without the source. You must specify the source of a note
when creating it.
4.1.3.2 Note Context

The note context is a business object that is related to the note, but is not its source.
For example, a note is created for a task, but, in addition, it is related to a party, an
opportunity and an employee. Note context is not required when you create a note.
The following table describes some of the important parameters related to both the
note source and note context.
Table 4–2 Note Source and Context Parameters

Parameter Description
p_source_object_code This parameter contains (references) the source business
object. For example, this could be a party, a task, or a service
request. This parameter is not the software module that
created the note. For example, it is not Customer Care, or the
Contact Center.
p_source_object_id This parameter relates to the business object specified in
p_source_object_code, but refers to a particular instance of the
business object. For example, this could be the party_id for a
party, or the service_request_id of a service request.
p_context This is a short description field for the context business object.
p_note_context_type This value is passed as a parameter in the internal call to the
Create_Note_Context API. It is the business object that is
related to, but is not the source of, the note. It is similar to
p_source_object_code.
p_note_context_type_id This value is passed as a parameter in the internal call to the
Create_Note_Context API. It is similar to p_source_object_id.

The p_note_context_type parameter and the p_note_context_type_id parameter are

stored as data items in the p_jtf_note_contexts_tab record. See Section 4.1.1.1,
"Record jtf_note_contexts_rec_type" for details of this data structure.
4.1.4 Party Relationships

For notes related to a party business object (no matter what party type), use only the
PARTY type definition. That is, do not use:
■ PARTY_PERSON
■ PARTY_GROUP
■ PARTY_RELEATIONSHIP
■ PARTY_ORGANIZATION
You must define the note as type PARTY to be able to find, across the entire
e-Business Suite, any note created for a specific party.
Note: It is not necessary to populate the source object into the

notes context table. This action is performed automatically by the
Notes APIs.
Note Contexts that Relate to a Customer

When a note is created for a source that contains customer information, then the
customer information must be included as part of the context for that note. This
ensures that all notes relating to that customer can be viewed in a single place. To
do this, set the value for p_note_context_type to PARTY.
Note Contexts that Relate to a Relationship

If a note is created for a source that contains customer information that includes
relationship information such as a member of an organization, then it must create
three separate instances of p_jtf_note_contexts_tab records (discussed in
Section 4.1.1.1, "Record jtf_note_contexts_rec_type") that contain the following:
1. Information related to the organization in which the person works.
2. The party identifier for party of type "relationship." Do not use PARTY_
RELATIONSHIP, instead use PARTY for the p_note_context_type parameter.
3. The party identifier (party_id) for the person.

Example of a Party Relationship

The following table lists information needed to specify the relationship of John Doe
at Oracle (john.doe@oracle). It is stored in the PARTY tables in the database.
Party ID Party Type Party Name

1000 ORGANIZATION Oracle
1100 PERSON John Doe
1200 PARTY_RELATIONSHIP John.Doe@Oracle
The following table lists the values for the context information needed to specify
John.Doe@Oracle. The context business object is the p_note_context_type parameter.
The context business object identifier is p_context_type_id.
p_note_context_type p_context_type_id
PARTY 1000
PARTY 1100
PARTY 1200
4.1.5 Create_Note
Use the Create_Note API to generate a text note. This API Performs the following
tasks:
■ It validates the note status, length, type, and ID.
■ It creates a note record and writes it to the database.
■ It writes any related contexts to the database.

Example Note Parameter Values

The following table lists the input parameters associated with a note that was
created and attached to service request 4039. This note was created as a private note,
on September 2, 2000.
Table 4-1 Note Parameter Value Example

Parameter Value
p_parent_note_id NULL
p_jtf_note_id 209
p_source_object_id 4039
p_source_object_code SR
p_note_status E
p_entered_by 1000194
p_entered_date 09/02/2000 12:42:22 PM
p_last_update_date 09/02/2000 12:42:22 PM
p_last_updated_by 1000194
p_creation_date 09/02/2000 12:42:22 PM
p_created_by 1000194
p_last_update_login 519018
p_note_type AS_USER
PROCEDURE Create_Note
( p_parent_note_id IN NUMBER DEFAULT NULL,
p_jtf_note_id IN NUMBER DEFAULT NULL,
p_api_version IN NUMBER,
p_init_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE,
p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE,
p_validation_level IN NUMBER DEFAULT FND_API.G_VALID_LEVEL_FULL,
x_return_status OUT VARCHAR2,
x_msg_count OUT NUMBER,
x_msg_data OUT VARCHAR2,
p_org_id IN NUMBER DEFAULT NULL,
p_source_object_id IN NUMBER,
p_source_object_code IN VARCHAR2,
p_notes IN VARCHAR2,

p_notes_detail IN VARCHAR2 DEFAULT NULL,

p_note_status IN VARCHAR2 DEFAULT 'I',
p_entered_by IN NUMBER,
p_entered_date IN DATE,
x_jtf_note_id OUT NUMBER,
p_last_update_date IN DATE,
p_last_updated_by IN NUMBER,
p_creation_date IN DATE,
p_created_by IN NUMBER DEFAULT FND_GLOBAL.USER_ID,
p_last_update_login IN NUMBER DEFAULT FND_GLOBAL.LOGIN_ID,
p_attribute1 IN VARCHAR2 DEFAULT NULL,
p_context IN VARCHAR2 DEFAULT NULL,
p_note_type IN VARCHAR2 DEFAULT NULL,
p_jtf_note_contexts_tab IN jtf_note_contexts_tbl_type
DEFAULT jtf_note_contexts_tab_dflt
);
Current Version
1.0

Table 4–3 Create_Note IN Parameters

p_parent_note_id NUMBER No Identifier of the parent note, if any.
p_jtf_note_id NUMBER No Note identifier; this must be unique, if it is
not, an error is raised. You must use the JTF_
NOTES_S sequence to generate valid values.
p_api_version NUMBER Yes See "Standard IN Parameters" on page 1-3.
p_init_msg_list VARCHAR2 No See "Standard IN Parameters" on page 1-3.
p_commit VARCHAR2 No See "Standard IN Parameters" on page 1-3.
p_validation_level NUMBER No This values determines whether validation
should occur or not. This variable is checked
against FND_API.G_VALID_LEVEL_NONE
and if it is greater than the latter, validation
occurs.
p_org_id NUMBER No An identifier for the organization.
p_source_object_id NUMBER No Dependent on parameter p_source_object_
code; for example, if the source business
object is a service request, this is the service
request number.
See Section 4.1.3, "Note Source and Note
Context" on page 4-2 for more details.
p_source_object_code VARCHAR2 No The source business object for the note; for
example, this could be TASK if the source
object is a task, or ESC if the source object is
an escalated document.
Context" on page 4-2 for more details.
p_notes VARCHAR2 Yes The actual note text, passed from the source
application.
p_notes_detail VARCHAR2 No This parameter is used to store larger notes
of up to 32k.


p_notes_status VARCHAR2 No Indicates the status of the note. Choices are:
■ Private (E)
■ Internal (I)
■ Publish (P)
This value must be either E, I, or P. If it is
not, an error is raised. If none is provided, I
is used.
p_entered_by NUMBER Yes Identifies the Oracle Applications user who
entered this record. If a valid user identifier
is not provided, an error is raised.
p_entered_date DATE Yes The date that the record was entered. If not
provided, SYSDATE is used.
p_last_update_date DATE Yes The date that this record was last updated. If
not provided, SYSDATE is used.
p_last_updated_by NUMBER No Identifies the Oracle Applications user who
last updated this record.
p_creation_date DATE Yes The date on which this note was first
created. If not provided, SYSDATE is used.
p_created_by NUMBER No Identifies the Oracle Applications user who
first created this record.
p_last_update_login NUMBER No Identifies the login session of the Oracle
Applications user that last updated the note.
p_attribute1 VARCHAR2 No Descriptive Flexfield Segment


p_context VARCHAR2 No This is a short description field.
p_note_type VARCHAR2 No The type of note, based on the source
business object; for example, this could be
SR_PROBLEM, if the note concerns a service
request problem. If this value is not valid, an
error is raised.
p_jtf_note_contexts_tab jtf_note_contexts_tbl_type No Table of PL/SQL records used to specify the
note context.
Context" on page 4-2 and Section 4.2,
"Messages and Notifications" on page 4-13
for more details.
Table 4–4 Create_Note OUT Parameters

x_jtf_note_id NUMBER The unique note identifier. This value is the same as
p_jtf_note_id.

4.1.6 Update_Note
Use the Update_Note API to modify an existing text note. This API Performs the
following tasks:
■ Validates the note status, length, type, and ID.
■ It update an existing note record and replaces the existing version in the
database with the modified version.
■ It updates any related context information in the database, if necessary.
PROCEDURE Update_note
( p_api_version IN NUMBER,
p_init_msg_list IN VARCHAR2 DEFAULT fnd_api.g_false,
p_commit IN VARCHAR2 DEFAULT fnd_api.g_false,
p_validation_level IN NUMBER DEFAULT fnd_api.g_valid_level_full,
x_return_status OUT VARCHAR2,
x_msg_count OUT NUMBER,
x_msg_data OUT VARCHAR2,
p_jtf_note_id IN NUMBER,
p_entered_by IN NUMBER,
p_last_updated_by IN NUMBER,
p_last_update_date IN DATE DEFAULT Sysdate,
p_last_update_login IN NUMBER DEFAULT NULL,
p_notes IN VARCHAR2 DEFAULT fnd_api.g_miss_char,
p_notes_detail IN VARCHAR2 DEFAULT fnd_api.g_miss_char,
p_append_flag IN VARCHAR2 DEFAULT fnd_api.g_miss_char,
p_note_status IN VARCHAR2 DEFAULT 'I',
p_note_type IN VARCHAR2 DEFAULT fnd_api.g_miss_char,
p_jtf_note_contexts_tab IN jtf_note_contexts_tbl_type
DEFAULT jtf_note_contexts_tab_dflt
);
Current Version
1.0

Table 4–5 Update_Note IN Parameters

p_api_version NUMBER Yes See "Standard IN Parameters" on page 1-3.
p_init_msg_list VARCHAR2 No See "Standard IN Parameters" on page 1-3.
p_commit VARCHAR2 No See "Standard IN Parameters" on page 1-3.
p_validation_level NUMBER No This value determines whether validation
should occur or not. The variable is checked
against FND_API.G_VALID_LEVEL_NONE
and if it is greater than the latter, validation
is performed.
p_jtf_note_id NUMBER Yes Note identifier; this must be unique, if it is
not, an error is raised. You must use the JTF_
NOTES_S sequence to generate valid values.
p_entered_by NUMBER Yes This is employee ID of the person who
entered the note.
p_last_updated_by NUMBER Yes Corresponds to the column USER_ID in the
table FND_USER, and identifies the Oracle
Applications user who updated this record.
p_last_update_date DATE No The date on which this record was updated.
p_last_update_login NUMBER No Corresponds to the column LOGIN_ID in
the table FND_LOGINS, and identifies the
login session of the user.
p_notes VARCHAR2 No The updated note text.
p_notes_detail VARCHAR2 No Used to create larger notes of up to 32K. If
p_append_flag is set to Yes, then p_notes_
detail is appended to p_notes.
p_append_flag VARCHAR2 No Boolean value: Used to specify if p_notes_
detail is to be appended to the existing p_
notes_detail:
■ TRUE: Append p_notes_detail to p_
notes_detail.
■ FALSE: Do not append p_notes_detail
to p_notes_detail.

Table 4–5 Update_Note IN Parameters

p_note_status VARCHAR2 No Indicates the status of the note. Choices are:
■ Private
■ Internal (Default)
■ Publish
Note that only the owner of the note can
update the Private status of a note. The
owner of the note is defined by the p_
entered_by parameter.
p_note_type VARCHAR2 No This value must be one of the note types
defined as lookup codes for JTF_NOTE_
TYPE.
p_jtf_note_contexts_tab jtf_note_contexts_tbl_type No Table of PL/SQL records to specify the note
context.
Context" on page 4-2 and Section 4.2,
"Messages and Notifications" on page 4-13
for more details.
Table 4–6 Update_Note OUT Parameters


The APIs contained in package JTF_NOTES_PUB generate messages and
notifications as needed. These messages are detailed in section 6.3.1.
Note: Status notifications are not required to provide a number

identifier along with the message, although, in many cases, it is
provided.

Sample Code
4.2.1 JTF_NOTES_PUB
Note and Update_Note APIs.
Table 4–7 Create_Note and Update_Note Messages

Type Name Text
E JTF_API_ERR_PRE_CUST_USR_HK API Programming Error (&API_NAME): Returned Error
Status from the Pre Customer User Hook.
E JTF_API_ERR_PRE_VERT_USR_HK API Programming Error (&API_NAME): Returned Error
Status from the Pre Vertical User Hook.
E JTF_API_ERR_POST_CUST_USR_HK API Programming Error (&API_NAME): Returned Error
Status from the Post Customer User Hook.
E JTF_API_ERR_POST_VERT_USR_HK API Programming Error (&API_NAME): Returned Error
Status from the Post Vertical User Hook.
E JTF_API_ALL_INVALID_ARGUMENT API Programming Error (&API_NAME): The value of
"&VALUE" for &PARAMETER is invalid.
E JTF_API_ALL_MISSING_PARAM API Programming Error (&API_NAME): Parameter
&MISSING_PARAM is required and was not passed in.
E JTF_API_ALL_NULL_PARAMETER API Programming Error (&API_NAME): The value of
&NULL_PARAM cannot be NULL.
E JTF_API_ALL_VALUE_TRUNCATED API Programming Warning (&API_NAME): The parameter
&TRUNCATED_PARAM was truncated because the
character value (&VAL_LEN) is longer than the defined
width of the VARCHAR2 column (&DB_LEN).
4.3 Sample Code

This section contains SQL scripts that call the Notes public APIs contained in the
JTF_NOTES_PUB package and insert values as required.
4.3.1 Package JTF_NOTES_PUB

The SQL scripts in this section create and update a note by calling the Create_Note
and Update_Note APIs in succession and by providing them with the required
values.

Sample Code
4.3.1.1 Create_Note
This script calls the Create_Note API and creates a note with the following
information:
■ Source object ID: 151263
■ Source object: Task Manager
■ Note status: Publish
■ Note type: General
■ Note text: These are the directions to my office
DECLARE
l_api_version NUMBER;
l_init_msg_list VARCHAR2(1);
l_validation_level NUMBER;
l_commit VARCHAR2(1);
l_msg_count NUMBER;
l_jtf_note_id NUMBER;
l_source_object_id NUMBER;
l_source_object_code VARCHAR2(8);
l_note_status VARCHAR2(8);
l_note_type VARCHAR2(80);
l_notes VARCHAR2(2000);
l_notes_detail VARCHAR2(8000);
l_last_update_date DATE;
l_last_updated_by NUMBER;
l_creation_date DATE;
l_created_by NUMBER;
l_last_update_login NUMBER;
l_entered_by NUMBER;
l_entered_date DATE;
l_note_contexts JTF_NOTES_PUB.jtf_note_contexts_tbl_type;
l_msg_index NUMBER;
l_msg_index_out NUMBER;
BEGIN
-- Initialize the Notes parameters you want to create
l_api_version := 1.0;
l_init_msg_list := FND_API.g_true;
l_validation_level := FND_API.g_valid_level_full;
l_commit := FND_API.g_true;

Sample Code
l_msg_count := 0;
l_source_object_id := 151263;
l_source_object_code := 'TASK';
l_note_status := 'P';
l_note_type := 'GENERAL';
l_notes := 'These are the directions to my office';
l_notes_detail := 'These are the directions to my office';
l_entered_by := FND_GLOBAL.user_id;
l_entered_date := SYSDATE;
-- Initialize Who columns

l_last_update_date := SYSDATE;
l_last_updated_by := FND_GLOBAL.USER_ID;
l_creation_date := SYSDATE;
l_created_by := FND_GLOBAL.USER_ID;
l_last_update_login:= FND_GLOBAL.LOGIN_ID;
-- Initialize the Notes Context parameters (optional)

l_note_contexts(1).note_context_type := 'SR';
l_note_contexts(1).note_context_type_id := 1;
l_note_contexts(1).last_update_date := SYSDATE;
l_note_contexts(1).last_updated_by := FND_GLOBAL.USER_ID;
l_note_contexts(1).creation_date := SYSDATE;
l_note_contexts(1).created_by := FND_GLOBAL.USER_ID;
l_note_contexts(1).last_update_login := FND_GLOBAL.LOGIN_ID;
l_note_contexts(2).note_context_type := 'TASK';
l_note_contexts(2).creation_date := SYSDATE;
l_note_contexts(2).created_by := FND_GLOBAL.USER_ID;
-- Call the API

jtf_notes_pub.Create_note
( p_api_version => l_api_version,
p_init_msg_list => l_init_msg_list,
p_commit => l_commit,
p_validation_level => l_validation_level,
p_jtf_note_id => l_jtf_note_id,
p_entered_by => l_entered_by,

Sample Code
p_entered_date => l_entered_date,

p_source_object_id => l_source_object_id,
p_source_object_code => l_source_object_code,
p_notes => l_notes,
p_notes_detail => l_notes_detail,
p_note_type => l_note_type,
p_note_status => l_note_status,
p_jtf_note_contexts_tab => l_note_contexts,
x_jtf_note_id => l_jtf_note_id,
p_last_update_date => l_last_update_date,
p_last_updated_by => l_last_updated_by,
p_creation_date => l_creation_date,
p_created_by => l_created_by,
p_last_update_login => l_last_update_login
);
-- Check for errors
IF (fnd_msg_pub.count_msg > 0)
THEN
FOR i IN 1..fnd_msg_pub.count_msg
LOOP
fnd_msg_pub.get
( p_msg_index => i,
p_encoded => 'F',
);
DBMS_OUTPUT.PUT_LINE('API ERROR: ' || l_msg_data);
END LOOP;
ELSE
DBMS_OUTPUT.PUT_LINE('Created note : ' || to_char(l_jtf_note_id));
END IF;
END;
4.3.1.2 Update_Note
This script calls the Update_Note API and updates the previously created note with
the following values:
■ Note status: E (Private)
■ Note type: Call Back
DECLARE

Sample Code
l_api_version NUMBER;
l_init_msg_list VARCHAR2(1);
l_validation_level NUMBER;
l_commit VARCHAR2(1);
l_msg_count NUMBER;
l_jtf_note_id NUMBER;
l_note_status VARCHAR2(8);
l_note_type VARCHAR2(80);
l_notes VARCHAR2(2000);
l_notes_detail VARCHAR2(32000);
l_append_flag VARCHAR2(1);
l_last_update_date DATE;
l_last_updated_by NUMBER;
l_last_update_login NUMBER;
l_entered_by NUMBER;
l_note_contexts JTF_NOTES_PUB.jtf_note_contexts_tbl_type;
l_msg_index NUMBER;
l_msg_index_out NUMBER;
BEGIN
-- Initialize the API
l_api_version := 1.0;
l_init_msg_list := FND_API.g_true;
l_validation_level := FND_API.g_valid_level_full;
l_commit := FND_API.g_true;
l_msg_count := 0;
-- Initialize Notes parameters you want to update

l_jtf_note_id := 151263;
l_note_status := 'E';
l_note_type := 'Call Back';
l_notes := 'These are the directions to my office';
l_notes_detail := 'These are the directions to my office';
l_entered_by := FND_GLOBAL.user_id;
-- Initialize Who columns

l_last_update_date := SYSDATE;
l_last_updated_by := FND_GLOBAL.USER_ID;
l_last_update_login:= FND_GLOBAL.LOGIN_ID;
-- Initialize the Notes Context parameters (optional)

l_note_contexts(1).jtf_note_id := 151263;
l_note_contexts(1).note_context_id := 151149;

Sample Code
l_note_contexts(1).note_context_type := 'SR';
l_note_contexts(2).jtf_note_id := 151263;
l_note_contexts(2).note_context_id := 151149;
l_note_contexts(2).note_context_type := 'TASK';
-- Call the API

jtf_notes_pub.Update_note
( p_api_version => l_api_version,
p_init_msg_list => l_init_msg_list,
p_commit => l_commit,
p_validation_level => l_validation_level,
p_jtf_note_id => l_jtf_note_id,
p_entered_by => l_entered_by,
p_notes => l_notes,
p_notes_detail => l_notes_detail,
p_append_flag => l_append_flag,
p_note_type => l_note_type,
p_note_status => l_note_status,
p_last_update_date => l_last_update_date,
p_last_updated_by => l_last_updated_by,
p_last_update_login => l_last_update_login,
p_jtf_note_contexts_tab => l_note_contexts
);
-- Check for errors

IF (fnd_msg_pub.count_msg > 0)
THEN
FOR i IN 1..fnd_msg_pub.count_msg
LOOP
fnd_msg_pub.get
( p_msg_index => i,
p_encoded => 'F',

Sample Code
);
DBMS_OUTPUT.PUT_LINE('API ERROR: ' || l_msg_data);
END LOOP;
ELSE
DBMS_OUTPUT.PUT_LINE('Updated note : ' || to_char(l_jtf_note_id));
END IF;
END;

Index
C Procedure Specification, 3-49
Delete_References, 3-3
Create Note, 4-2, 4-5
Parameter Descriptions, 4-8
Procedure Specification, 4-6 I
Create Resource, 2-3, 2-32 Interaction Record Type, 4-2
Parameter Descriptions, 2-5 Introduction, 1-1
Procedure Specification, 2-3
Create Resource Group, 2-19
Parameter Descriptions, 2-20 J
Procedure Specification, 2-19 JTF_IH_PUB
Create SalesRep, 2-24 Create Interaction, 4-2
Parameter Descriptions, 2-26 Create Media Item, 4-11
Procedure Specification, 2-25 Parameter Descriptions, 4-12
Create Task, 3-2, 3-5, 3-9 Procedure Specification, 4-11
Parameter Descriptions, 3-11 JTF_NOTES_PUB, 4-1
Procedure Specification, 3-9 Create Note, 4-5
Create Task Assignment, 3-2, 3-29, 3-30 Parameter Descriptions, 4-8
Parameter Descriptions, 3-32 Procedure Specification, 4-6
Create Task Reference, 3-42, 3-43 Update Note
Parameter Descriptions, 3-44 Parameter Descriptions, 4-12
Procedure Specification, 3-43 Procedure Specification, 4-11
Create_References, 3-2 JTF_RESOURCES_PUB, 2-1, 2-3
Create Resource, 2-1, 2-3, 2-32
D Parameter Descriptions, 2-5
Delete Task, 3-2, 3-5, 3-27 Update Resource, 2-1, 2-11
Parameter Descriptions, 3-28 Parameter Descriptions, 2-13
Procedure Specification, 3-28 Procedure Specification, 2-12
Delete Task Assignment, 3-2, 3-29, 3-40 JTF_RS_GROUPS_PUB, 2-2, 2-19
Parameter Descriptions, 3-41 Create Resource Group, 2-19
Procedure Specification, 3-40 Parameter Descriptions, 2-20
Delete Task Reference, 3-42, 3-49 Procedure Specification, 2-19
Parameter Descriptions, 3-49 Update Resource Group, 2-21
Index-1
Parameter Descriptions, 2-22 Messages and Notifications, 4-13
Procedure Specification, 2-21 Update Note, 4-11
JTF_RS_SALESREPS_PUB, 2-2, 2-24 Note Source, 4-2
Create SalesRep, 2-2, 2-24 Party Relationships, 4-4
P
Update SalesRep, 2-2, 2-28
Parameter Descriptions, 2-29 Parameter Specifications, 1-2
Procedure Specification, 2-28 Invalid Parameters, 1-6
JTF_TASKS_ASSIGNMENTS_PUB, 3-29 Missing Parameter Attributes, 1-5
Create Task Assignment, 3-30 Parameter Validations, 1-5
Parameter Descriptions, 3-32 Standard IN Parameters, 1-3
Delete Task Assignment, 3-40 Standard OUT Parameters, 1-4
Procedure Specification, 3-40 R
Update Task Assignment, 3-36
Parameter Descriptions, 3-37 Resource Manager, 2-1
Procedure Specification, 3-36 JTF_RESOURCES_PUB, 2-3
JTF_TASKS_PUB, 3-5 Create Resource, 2-3
Create Task, 3-9 Update Resource, 2-11
Parameter Descriptions, 3-11 JTF_RS_GROUPS_PUB
Procedure Specification, 3-9 Create Resource Group, 2-19
Delete Task, 3-27 Update Resource Group, 2-21
Parameter Descriptions, 3-28 JTF_RS_SALESREPS_PUB
Procedure Specification, 3-28 Create Sales Rep, 2-24
Update Task, 3-19 Update SalesRep, 2-28
Parameter Descriptions, 3-21 Messages and Notifications, 2-32
Procedure Specification, 3-19 Resource Manager Public APIs, 2-2
JTF_TASKS_REFERENCES_PUB, 3-42
Create Task Reference, 3-43 S
Sort Record Type, 3-5
Delete Task Reference, 3-49 Status Messages, 1-6
Parameter Descriptions, 3-49 Error, 1-7
Success, 1-6
Update Task Reference, 3-46 Unexpected error, 1-7
Parameter Descriptions, 3-47 Warning and Information Messages, 1-7
T
N Task Assign Record Type, 3-5
Task Contact Record Type, 3-5, 3-7
Notes
Task Dates Record Type, 3-5, 3-7
JTF_NOTES_PUB
Create Note, 4-2 Task Dependency Record Type, 3-5, 3-6
Task Manager, 3-2
Data Structure Specifications, 4-2
Index-2
Data Structure Specifications, 3-5 Parameter Descriptions, 3-47
Task Assignment Record Type, 3-5 Procedure Specification, 3-46
Task Contact Record Type, 3-7 Update_References, 3-2
Task Dates Record Type, 3-7
Task Dependency Record Type, 3-6
Task Recurrence Record Type, 3-7
Task Reference Record Type, 3-6
JTF_TASKS_ASSIGNMENTS_PUB, 3-29
Create Task Assignment, 3-30
Delete Task Assignment, 3-40
Update Task Assignment, 3-36
JTF_TASKS_PUB, 3-5
Create Task, 3-9
Delete Task, 3-27
Update Task, 3-19
JTF_TASKS_REFERENCES_PUB, 3-42
Create Task Reference, 3-43
Delete Task Reference, 3-49
Update Task Reference, 3-46
Messages and Notifications, 3-50
Task Notes Record Type, 3-5
Task Recurrence Record Type, 3-5, 3-7
Task Reference Record Type, 3-5, 3-6
U
Update Note, 4-2, 4-11
Update Resource, 2-11
Update Resource Group, 2-19, 2-21
Update SalesRep, 2-24, 2-28
Update Task, 3-2, 3-5, 3-19
Update Task Assignment, 3-2, 3-29, 3-36
Update Task Reference, 3-42, 3-46
Index-3
Index-4

Oracle® Common Application Components: API Reference Guide Release 11i

Uploaded by

Copyright:

Available Formats

Oracle® Common Application Components: API Reference Guide Release 11i

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Oracle® Common Application Components: API Reference Guide Release 11i

Uploaded by

Copyright:

Available Formats

Oracle® Common Application Components

API Reference Guide

Part No. B10562-01

Copyright © 2000, 2003 Oracle Corporation. All rights reserved.

Primary Authors: Charles Colt, Melody Yang

Contributing Authors: Kellie Briesach, Carol Fager-Higgins, Robert Geiwitz

Send Us Your Comments .................................................................................................................. vii

2 Resource Manager Public APIs

3 Task Manager Public APIs

4 Notes Public APIs

Audience for This Guide

Note: This document provides API information for the following

This guide assumes you have a working knowledge of the following:

How To Use This Guide

Chapter Title Summary

Accessibility of Code Examples in Documentation

Other Information Sources

Documents Related to All Products

Oracle Applications User’s Guide

Documents Related to This Product

Oracle Common Application Components Implementation Guide

Oracle Common Application Components User’s Guide

Installation and System Administration

Oracle Applications Concepts

Installing Oracle Applications

Upgrading Oracle Applications

Maintaining Oracle Applications

Oracle Applications System Administrator’s Guide

Oracle Alert User’s Guide

Oracle Applications Developer’s Guide

Other Implementation Documentation

Oracle Workflow Administrator's Guide

Oracle Workflow Developer's Guide

Oracle Workflow User's Guide

Oracle Workflow API Reference

Oracle eTechnical Reference Manuals

Oracle Manufacturing APIs and Open Interfaces Manual

Oracle Applications Message Reference Manual

Training and Support

Do Not Use Database Tools to Modify Oracle Applications Data

The Oracle e-Business Suite contains the following types of APIs:

Note: In Applications release 11.5.9, many of the Applications'

The Common Application Components APIs

Note: The words procedure and API are used interchangeably in

1.1 Parameter Specifications

1-2 Oracle Common Application Components API Reference Guide

1.1.1 Standard IN Parameters

Table 1–1 Standard IN Parameters

Table 1–1 Standard IN Parameters

p_commit VARCHAR2(1) No The valid values for this parameter are:

1.1.2 Standard OUT Parameters

Note: All standard OUT parameters are required.

Table 1–2 Standard OUT Parameters

1-4 Oracle Common Application Components API Reference Guide

Table 1–2 Standard OUT Parameters

1.1.3 Parameter Size

1.1.4 Missing Parameter Attributes

Table 1–3 Initialized IN Parameters

1.1.5 Parameter Validations