Workflows for Change and Document Management

This appendix covers the following topics:

Workflows for Change and Document Management

The system uses Oracle Workflow technology to automate business processes in Change Management, Document Management and Collaboration (DOM), and Group Member registration. You must set up Oracle Workflow to implement Oracle Product Lifecycle Management or Oracle Product Information Management.

Important: Oracle Product Lifecycle Management (PLM) and Oracle Product Information Management (PIM) share a common technological foundation, but address different business needs through a different mix of core functions, plus specific functions that are unique to each product. Document Management and Collaboration (DOM) is available only to customers who have licensed Product Lifecycle Management, and it is not available to licensees of Product Information Management. Change Management is a core function, available to licensees of both products.

Additional Information: Run wfver.sql under $FND_TOP/sql for detailed information about workflow versions.

Workflow Setup

Refer to the Oracle Workflow Implementation and User Documentation required for setup.

Overview of Change and Document Management Workflows

Change and Document Management use Oracle Workflow technology to execute workflow routing for a change and document objects and events occurring in a change or document object (such as Submit, Reassign, Priority Change, and Status Change actions). Change and Document Management enable you to model your business processes in terms of generic order processes. So you can model your business processes by customizing or extending seeded workflow processes and/or modifying custom hook PL/SQL procedures.

Viewing Processes in Oracle Workflow Builder

From within the Oracle Workflow Builder you can view the different workflow processes and their associated functions, messages, subprocesses, notifications, and properties.

To view processes in Oracle Workflow Builder:

  1. Within Oracle Workflow Builder, select Open from the File menu and connect to the database. Alternatively, you can connect to the workflow definitions file engchgmt.wft located in the product directory tree of your Oracle Applications server.

  2. Expand the data source, and then select the item type branch within that data source.

  3. Expand the processes branch within your item type and select a process activity to display the diagram of the process in a Process window.

Display Name (Internal Name) Purpose Location of Flat File Store on Server (Location of other Flat File Stores with Item Type embedded)
ENG: Standard(ENGWFSTD) Contains a collection of commonly used (by other Eng Workflow Item Types) Function Activities and Lookup Types.If the activity will be shared by more than one object's process, create the activity in the ENG: Standard (ENGWFSTD) item type. Otherwise, create the activity in the appropriate object's item type $ENG_TOP/patch/115/import//engchmgt.wft
Change (ENGCACT) Contains activities, attributes, notifications, and processes used by Change Action Process $ENG_TOP/patch/115/import//engchmgt.wft
Change Line (ENGCLACT) Contains activities, attributes, notifications, and processes used by Change Line Action Process $ENG_TOP/patch/115/import//engchmgt.wft
Change Workflow Routing(ENGCRT) Contains activities, attributes, notifications, and processes used by Change Approval Routing Process $ENG_TOP/patch/115/import//engchmgt.wft
Change Workflow Routing Step(ENGCSTEP) Contains activities, attributes, notifications, and processes used by Change Approval Routing Step Process $ENG_TOP/patch/115/import//engchmgt.wft

Pre-Seeded Workflow Processes

Change (ENGCACT)

Process Internal Name Process Display Name Description
INITIATE_CHANGE Initiate Change Sends an assignment notification to assignee and starts “Initiate Change Line” workflow if Change has a line. This workflow is started when users submit a Change Object.
PRIORITY_CHANGE Priority Change Sends a priority change notification to Requestor, Owner, and Assignee for changes. This workflow is started when users change the priority for a Change Object.
REASSIGN_CHANGE Reassign Change Sends an assignment notification to assignee. This workflow is started when users reassign a Change Object.
REQUEST_COMMENT Request Comment Sends a notification to request comment to specified people on the Request Comment Action page. When the recipient responds to the request notification, Workflow sends a response notification to the requestor. This workflow is started when users request comment for a Change Object.
RESPONSE_FYI Send Response FYI This process is called when the recipient responds to the request notification in Request Comment workflow process.
STATUS_CHANGE Status Change Sends a status change notification to Requestor, Owner, and Assignee for a change. This workflow is started when users change the status for a Change Object.

Change Line (ENGCLACT)

Process Internal Name Process Display Name Description
INITIATE_CHANGE Initiate Change Sends an assignment notification to assignee. This workflow is started from the Change Header's Initiate Change Workflow or when a user creates a Change Line if Change Header is Open.
REASSIGN_CHANGE Reassign Change Sends an assignment notification to the assignee. This workflow is started when a user reassigns a Change Line.
STATUS_CHANGE Status Change Sends a status change notification to Header Requestor, Header Owner, Header Assignee, Line Owner and Line Assignee. This workflow is started when a user changes status for a Change Line.

Change Workflow Routing (ENGCRT)

Process Internal Name Process Display Name Description
ROUTE_AGENT Workflow Routing Agent Controls Workflow Routing and sends Approval Status change notification to Requestor, Owner, and Assignee for a Change. This workflow is started when a user submits an Workflow Routing for a Change Object. Also this workflow is aborted when user aborts an Workflow Routing.

Change Workflow Routing Step (ENGCSTEP)

Process Internal Name Process Display Name Description
REQUEST_DEFINITION Definition Sends a definition request notification to specified assignees on Workflow Routing page and controls definition request for New Item Request. If the assignees do not respond by the specified period, workflow will also send a reminder notification. Once the step is completed, workflow will return control parent Workflow Routing Agent workflow. This workflow is started from Workflow Routing Agent based on the definition of Workflow Routing.
REQUEST_DEFIINITION_AND_APPR Definition and Approval Sends a definition and approval request notification to specified assignees on Workflow Routing page and controls definition and approval request for New Item Request. If the assignees do not respond by the specified period, workflow will also send a reminder notification. Once the step is completed, workflow will return control parent Workflow Routing Agent workflow. This workflow is started from Workflow Routing Agent based on the definition of Workflow Routing.
REQUEST_APPROVAL Request Approval Sends an approval request notification to specified assignees on Workflow Routing page and controls approval request. If the assignees do not respond by the specified period, workflow will also send a reminder notification. Once the step is approved, workflow will return control parent Workflow Routing Agent workflow. This workflow is started from Workflow Routing Agent based on the definition of Workflow Routing.
REQUEST_COMMENT Request Comment Sends a comment request notification to specified assignees on Workflow Routing page and controls comment requests. If the assignees do not respond by the specified period, workflow will also send a reminder notification. Once the step is completed, workflow will return control parent Workflow Routing Agent workflow. This workflow is started from Workflow Routing Agent based on the definition of Workflow Routing.
SEND_FYI FYI Sends an FYI notification to specified assignees on Workflow Routing page. Once the step is completed, workflow will return control parent Workflow Routing Agent workflow. This workflow is started from Workflow Routing Agent based on the definition of Workflow Routing.

Following are two Process Attributes for the Workflow Routing Step workflow process:

  1. Default Change Role Instance Set (DEFAULT_CHANGE_ROLE)

    Assigned on current or last Workflow Routing. Implicit grants securely based on the steps workflow process.

    ENG_CHANGE_WF_APPROVERS -> Granted Role: Approver (ENG_CHANGE_APPROVER)

    ENG_CHANGE_WF_REVIWERS -> Granted Role: Reviewer (ENG_CHANGE_REVIEWER).

    Implicit Role (Instance Set) to be granted is defined in the Step workflow process attributes

    DEFAULT_CHANGE_ROLE

    In case of seeded Step Workflow Process

    Request Approval (DEFAULT_CHANGE_ROLE: “ENG_CHANGE_WF_APPROVERS”)

    The step assignees get “Approver” implicit role from instance set ENG_CHANGE_WF_APPROVERS.

    Request Comment & FYU (DEFAULT_CHANGE_ROLE: “ENG_CHANGE_WF_REVIEWERS”)

    The step assignees get “Reviewer” implicit role from instance set ENG_CHANGE_WF_REVIEWERS. Oracle Workflow does not support other roles by default.

  2. Activity Condition Code (ACTIVITY_CONDITION_CODE)

    Attribute will indicate whether or not the Condition radio box is displayed on the Workflow Routing Create/Update step page. Acceptable values are Y or N.

  3. Enable Flag in Type: Definition (DEFINITION)

    Attribute will indicate whether or not the this process is displayed in the Workflow Process pull-down list based on the Definition Type of Workflow Routing (Template) on the Workflow Routing Create/Update step page. Acceptable values are Y or N.

  4. Enable Flag in Type: Approval (APPROVAL)

    Attribute will indicate whether or not the this process is displayed in the Workflow Process pull-down list based on the Approval Type of Workflow Routing (Template) on the Workflow Routing Create/Update step page. Acceptable values are Y or N.

  5. Enable Flag in Type: Definition and Approval (DEFINITION_APPROVAL)

    Attribute will indicate whether or not the this process is displayed in the Workflow Process pull-down list based on the Definition and Approval Type of Workflow Routing (Template) on the Workflow Routing Create/Update step page. Acceptable values are Y or N.

  6. Enable Flag in Type: Generic (GENERIC)

    Attribute will indicate whether or not the this process is displayed in the Workflow Process pull-down list based on the Generic Type of Workflow Routing (Template) on the Workflow Routing Create/Update step page. Acceptable values are Y or N.

  7. Association Enabled Flag (ASSOC_ENABLED)

    Attribute will indicate whether or not the the association for the assignee is available in the Workflow Routing Step for New Item Request on the Create/Update step page. Acceptable values are Y or N. This atttribute is only applicable for “Definition” and “Definition and Approval” Workflow.

Seeded Workflow Item Attributes

The following table describes the common item attributes for Change and Document Management Workflow. Each Workflow Item Type should have these attributes.

All Item Type

Internal Name Display Name Description Type Length Misc info (used for etc)
CHANGE_ID Change Id Engineering Change Unique Identifier Number   Primary Key Values
CHANGE_NOTICE Change Number Engineering Change Number Text 30 Old Primary Key Values
CHANGE_NAME Change Name Engineering Change Name Text 240 Token replacement for messages.
ORGANIZATION_ID Organization Id Organization Id Number   Old Primary Key Values
ORGANIZATION_CODE Organization Code Organization Code Text 3 Token replacement for messages.
CHANGE_MANAGEMTENT_TYPE Change Management Type Change Management Type Text 40 Token replacement for messages.
DESCRIPTION ECO Description ECO Description Text 2000 Token replacement for messages.
STATUS Status Change Status Text 80 Token replacement for messages.
APPROVAL_STATUS Approval Status ECO Approval Status Text 80 Token replacement for messages.
PRIORITY Priority Priority Text 50 Token replacement for messages.
REASON Reason Reason Text 50 Token replacement for messages.
ASSIGNEE_NAME Assignee Name Assignee Name Text 360 Token replacement for messages.
ASSIGNEE_COMPANY Assignee Company Assignee Company Text 360 Token replacement for messages.
WF_USER_ROLE WF Owner User Role Role of Person Who Started the Workflow Role   Runtime information for the work item
WF_USER_ID WF Owner User Id User Id of Person Who Started the Workflow NUMBER   Runtime information for the work item
HOST_URL Host URL and port Host URL and port Text   Runtime information for the work item
DEFAULT_STYLE_SHEET Default Style Sheet Default Style Sheet Text 100 /OA_HTML/cabo/styles/blaf.cssTemporary placeholders for HTML notifications
CHANGE_DETAIL_PAGE_URL Change Detail Page URL Change Detail Page URL URL    
MESSAGE_TEXT_BODY Message Text Body Message Text Body Document   Temporary placeholders for notifications
MESSAGE_HTML_BODY Message HTML Body Message HTML Body Document   Temporary placeholders for notifications
REVIEWERS_ROLE Change Standard Reviewer Role Change Standard Reviewer Role Role   Temporary placeholders for notifications
ASSIGNEE_ROLE Assignee Role Assignee Role Role   Temporary placeholders for notifications
ACTION_ID Change Action Id Change Action Id Number   Primary Key for Change Actions (ENG_CHANGE_ACTIONS.ACTION_ID)
Runtime information for the work item
ADHOC_PARTY_LIST Adhoc Party List Adhoc Party List Text   Runtime information for the work item
ADHOC_PARTY_ROLE Adhoc Party Role Adhoc Party Role for Change Action Role   Temporary placeholders for notifications
RESPONSE_TIMEOUT Response Timeout Response Timeout in Minutes for Action calculated from Response_By_Date Number    
RESPONSE_COMMENT Response Comment Response Comment Text   Temporary placeholders for notifications
ATTACHMENTS Attachments Attachments Document   Temporary placeholders for notifications:Notification Detail Page Attachment LinkFND:entity===
WF_USER_ID WF Owner User Id User Id of Person Who Started/Aborted the Workflow NUMBER   Runtime information for the work item
WF_USER_ROLE WF Owner User Role Role of Person Who started/aborted the Workflow Role   Runtime information for the work item
WF_ADMINISTRATOR WF Administrator WF Administrator Role   Constant: SYSADMINFor WFERROR: DEFAULT_ERROR (Default Error Process.)
WF_SIG_POLICY Signature Policy Signature Policy Text   To use Signature Policy defaulting in future
ERROR_TIMEOUT WF Error Timeout Value Timeout Value in Days Number   Constant: 0For WFERROR: DEFAULT_ERROR (Default Error Process.)
RCS RCS version RCS version Text 240 RCS version
FROM_ROLE From Role From Role Role   Item Attribute which holds the From Role. (Message #FROM_ROLE)

ENGCLACT Specific Item Attributes (required attributes when you pass the change line ID to StartWorfklow API)

Internal Name Display Name Description Type Length Misc info (used for etc)
CHANGE_LINE_ID Change Line Id Engineering Change Line Unique Identifier Number   Primary Key Values
LINE_NAME Change Line Name Engineering Change Line Name Text 240 Token replacement for messages.
LINE_DESCRIPTION Change Line Description Change Line Description Text 4000 Token replacement for messages.
LINE_SEQUENCE_NUMBER Change Line Sequence Number Change Line Sequence Number Number   Token replacement for messages.
LINE_STATUS Change Line Status Change Line Status Text 80 Token replacement for messages.
LINE_ASSIGNEE_NAME Change Line Assignee Name Change Line Assignee Name Text 360 Token replacement for messages.
LINE_ASSIGNEE_COMPANY Change Line Assignee Company Change Line Assignee Company Text 360 Token replacement for messages.
LINE_REVIEWERS_ROLE Change Line Reviewer Role Change Line Reviewer Role Role   Temporary placeholders for notifications
LINE_ASSIGNEE_ROLE Change Line Assignee Role Change Line Assignee Role Role   Temporary placeholders for notifications
LINE_ATTACHMENTS Attachments Attachments Document   Temporary placeholders for notifications:Notification Detail Page Attachment LinkFND:entity===

ENGCRT Specific Item Attributes

Internal Name Display Name Description Type Length Misc info (used for etc)
ROUTE_ID Route Id (Workflow Routing Id) Route Id Number   Primary Key Values for Change Route
STEP_ID Current Step Id (Workflow Routing Step Id) Current Step Id Number   Primary Key Values for Current Step Id
ROUTE_PEOPLE_ROLE Route (Workflow Routing) People Role All people in the Workflow Routing workflow that have already been notified (i.e. completed or in process steps) Role   Temporary placeholders for notifications

ENGCSTEP Specific Item Attributes

Internal Name Display Name Description Type Length Misc info (used for etc)
ROUTE_ID Workflow Routing Id Workflow Routing Id Number   Primary Key Values for Change Route
STEP_ID Workflow Routing Step Id Current Step Id Number   Primary Key Values for Step Id
ROUTE_PEOPLE_ROLE Workflow Routing People Role All people in the Workflow Routing workflow that have already been notified (i.e. completed or in process steps) Role   Temporary placeholders for notifications
STEP_SEQ_NUM Workflow Routing Step Sequence Number Workflow Routing Step Sequence Number Number   Temporary placeholders for notifications
STEP_PEOPLE_ROLE Workflow Routing Step People Role Workflow Routing Step People Role Role   Temporary placeholders for notifications
STEP_CONDITION Workflow Routing Step Activity Condition Workflow Routing Step Activity Condition Text 30 Temporary placeholders for notifications
STEP_VOTING_OPTION Workflow Routing Step Voting Option for Activity Condition Workflow Routing Step Voting Option for Activity Condition Lookup   Standard Voting Option
YES_RESPONSE_PERCENT Yes Response Percentage of Votes Yes Response Percentage of Votes Number   Temporary placeholders for notifications
NO_RESPONSE_PERCENT No Response Percentage of Votes No Response Percentage of Votes Number   Temporary placeholders for notifications

Change Management Workflow PL/SQL Packages

Change Management Workflow Private APIs will contain the following list of packages. These are private APIs for reference purposes only for your customization.

Package Name File Name Description Location of Flat File Store on Server
ENG_WORKFLOW_PUB ENGBWKFS.pls
ENGBWKFB.pls
Private APIs: for developers or consultants at Oracle:
This package contains All PL/SQL Function for Workflow Function Activity.
$ENG_TOP/patch/115/sql
ENG_WORKFLOW_UTIL ENGUWKFS.pls
ENGUWKFS.pls
Private APIs: This package contains utility functions and procedures for Eng Workflows $ENG_TOP/patch/115/sql
ENG_WORKFLOW_NTF_UTIL ENGUNTFS.pls
ENGUNTFS.pls
This package contains utility functions and procedures for Eng Workflow Notifications $ENG_TOP/patch/115/sql
ENG_WORKLFOW_EXT ENGXWKFS.pls
ENGXWKFB.pls
This package contains procedures that serve as "hooks" into the Eng Workflows for customization of the workflows.
The "StartCustomWorkflow " and the "AbortCustomWorkflow" are called from ENG_WORKFLOW_UTIL package when a workflow process is started and aborted, respectively. Users with customized workflows can add their custom logic in these two procedures to be executed at the appropriate times.
Also GetCustomMessageBody is called from the seeded PL/SQL Document APIs when system generates notification. Users can customize the PL/SQL procedure to modify notification contents.
Additionally, users can create new procedures in this package for custom workflow activities.
$ENG_TOP/patch/115/sql