Reusable commands are stored Script Author commands that allow developers to define parameters to be passed to PL/SQL procedures, Forms commands, Java commands, Scripting blackboard commands, and constant commands.
Using Oracle Scripting release 11.5.7 and later, several reusable commands are installed in the applications database and are available out of the box for use from the Script Author. These seeded commands provide script developers with a set of tools to integrate with Oracle business applications, and perform a number of functions from a graphical script that integrate with the Trading Community Architecture (TCA) of Oracle Applications, as well as specific schema items in Oracle business applications such as Oracle TeleSales, Oracle TeleService, and Oracle Collections. For example, using the commands currently available, you can create a lead in Oracle TeleSales, register a customer for an event, or create contacts, party IDs or locations in the TCA. Currently, all of the seeded commands available are for business-to-business applications. These commands are all associated with a contact within an organization in the TCA architecture. These commands create, update, or retrieve information with a series of custom APIs that serve as wrappers around the actual business objects exposed by the business applications. These seeded commands are not applicable to business-to-consumer applications.
The table below lists the full set of seeded commands currently available:
| Command Function | Command Name | Description |
|---|---|---|
| Create Lead | ies_create_opp_for_lead | Creates an opportunity for an existing Oracle Telesales sales lead |
| Create Lead Opportunity | ies_create_opp_for_lead | Creates an opportunity for an existing Oracle Telesales sales lead |
| Send Collateral | ies_send_collateral | Creates a collateral request for One to One Fulfillment |
| Register for an Event | ies_create_event_reg | Registers a customer for an event |
| Register Interest for Organization | ies_create_interest_org | Registers a product interest at the Organization level |
| Register Interest for Contact | ies_create_interest_contact | Registers a product interest at the Contact (Person) level |
| Create Organization Contact | ies_create_org_contact | Creates a new customer in the CRM Trading Community Architecture (TCA) schema |
| Create Party Org Type | ies_create_party_org_type | Creates a Party organization in the TCA schema |
| Create Party Site | ies_create_party_site | Creates a Party Site in the TCA schema |
| Create Person Party | ies_create_person_party | Creates a Person Party in the TCA schema |
| Create Location | ies_create_location | Creates a location/address in the TCA schema |
| Update Organization Contact | ies_update_org_contact | Updates a contact in the TCA schema |
| Update Party Site | update_party_site | Updates a location/address in the TCA schema |
Each of the seeded commands listed above contains a number of parameters, as described in this section. Using Script Author release 11.5.7 or later, you must supply values for each of the parameters in order for the commands to be processed correctly in a script. These scripts can be executed either in the agent interface, or as a survey taken over the Web interface of Oracle Scripting.
For example, if you want to create a script that sends a collateral item to a customer, you would need to supply information such as the recipient's e-mail address, collateral ID, e-mail subject heading, and the content of the e-mail message that is sent to the customer with the collateral attachment. The values from these parameters can be derived from questions prompted for within the script (by supplying a list of values of collateral items, which the user selects at runtime), or they can be "hard coded" as constants in the Send Collateral reusable command.
The command parameters have been set up so they reference blackboard key names for many of these commands. This provides you with flexibility in using the commands by letting you either set the value of the blackboard key name to a constant, or requiring you to use each blackboard key name as the name of a node (also referred to as an "answer definition" or "question") which collects the appropriate value from the user at runtime. Thus, to use one of the seeded commands successfully, you must fully understand the set of parameters required for the command to execute, and facilitate the passing of those parameters in the script.
For example, consider how the Send Collateral command might be used: Imagine a scenario where you want to prompt the recipient for his or her e-mail address and the specific piece of collateral desired. However, you want to "hard code" the values to be used for the subject heading and e-mail message content. You can create a script which uses the pre-defined blackboard key names as the questions which are displayed at runtime. By collecting the runtime user's responses into these specific blackboard key names, you can simply invoke the Send Collateral reusable command without having to modify the command once it is pulled into the script.
Use of seeded commands in a script is considered customization, which is not supported. In order to use the seeded commands successfully, you must have a detailed understanding regarding the use of Oracle Scripting. Specifically, you must understand how to create and modify commands for graphical scripts in the Script Author, how to import, edit, and modify reusable commands, how to pass parameters in a command, how to use blackboard, constant, and Java commands, and more. You must understand and be certified in the relevant technologies (Java, PL/SQL, SQL) and be familiar with Oracle Applications administration. If using Java, you must be conversant with the appropriate methods of writing, testing, compiling, and deploying the custom code, how to reference the code from the Script Author, and where to administer Oracle Applications in the appropriate architecture so that your compiled Java is accessible. This may involve some Apache Web server administration or customization of other configuration files.
Seeded reusable commands are therefore documented to provide knowledgeable and trained developers with the appropriate information to use the commands.
All reusable commands function as expected and as documented at the time of this writing. Oracle warrants that these commands as documented function at the time of publication. Since many of the commands integrate with other Oracle Applications and with the applications database, no guarantee is provided by Oracle that these commands will continue to work in future releases.
Nor is the use of seeded commands supported from a training perspective. If you do not possess the appropriate skill sets as addressed above, Oracle recommends you do not attempt to use the seeded commands. Since use of seeded commands is customization, assistance is not available through Oracle Support Services. These commands are provided as an added service to our customers on an as-is basis. Use these components at your own risk.
This section provides details for all seeded commands, including each seeded command name, relevant package name, related building block script, and each command parameter, blackboard value, and a brief description of each.
This command creates a lead in Oracle Telesales.
Prerequisites
In order to successfully execute the Create Lead API, you must ensure that the user has the appropriate responsibilities and profile settings that provide the ability to create a lead through Oracle Telesales.
Package Name
IES_TELESALES_BP_PKG.create_sales_leads
Associated Building Block Script Name
ieslead.scr (Create Lead building block script)
Input Parameters
The parameters passed by this seeded command are as follows:
| Parameter | Blackboard Key Name | Description |
|---|---|---|
| p_api_version | Constant | The version number for the API. This value is pre-set and does not need to be changed. |
| p_budget_amount | P_BUDGET_AMOUNT | The amount of money that is being budgeted. This parameter is not required and can be set to a null value. If using the Create Lead building block script, the P_BUDGET_AMOUNT value is set by an answer in a panel within the Gather_Required_ Lead_Data group. |
| p_budget_status_code | P_BUDGET_STATUS_CODE | The status of the budget. This must be a valid BUDGET_STATUS in the AMS_LOOKUPS table. If using the Create Lead building block script, the P_ BUDGET_AMOUNT value is set by an answer in a panel within the Gather_Required_Lead_Data group. |
| p_channel_code | Constant | A channel code associated with the lead. This parameter is assigned a value in the reusable command and should not be changed. |
| p_contact_id | CONTACT_ID | The CONTACT_ID which identifies the person within the organization for whom the lead is being created. This must be a valid contact, and it is associated with the Party_ID. If the script using the reusable command has been called by OracleTelesales or Collections, this value is passed into the script with a Blackboard Name of CONTACT_ID. If the script has been called by Oracle Teleservice, the value of the CONTACT_ID can be retrieved by using the Forms command GetContactId and assigning its value as a constant for this parameter. If you are using the Create Lead building block script, the script checks to see if a CONTACT_ID has been passed by the calling application. If the value is null, it looks up the CONTACT_ID based on the PARTY_ID passed into the script. Otherwise, it provides a query allowing you to select the Contact person. Though it references the blackboard key CONTACT_ID, it is passing Null since CONTACT_ ID is never set. |
| p_currency_code | Constant - USD | A currency code. This value is pre-set and does not need to be changed. |
| p_customer_id | PARTY_ID | The Party_ID which identifies the organization with which this lead is associated. This value is required, and it must reference a valid organization. When a script is invoked by Oracle Telesales or Collections, this value is supplied as the PARTY_ID Blackboard Name. If the script has been called by Oracle Teleservice, the value of the PARTY_ID can be retrieved by using the Forms command GetCustomerId and assigning its value as a constant for this parameter. |
| p_decision_timeframe_ code | P_DECISION_TIMEFRAME_ CODE | The time frame in which the customer/prospect expects to purchase the product for which the lead is being created. This value must be a valid DECISION_TIMEFRAME in the AS_LOOKUPS table. If using the Create Lead building block script, the P_DECISION_TIMEFRAME_CODE value is set by a an answer in a panel within the Gather_ Required_Lead_Data group. |
| p_description | P_DESCRIPTION | A description of the project for which the lead is being created. The value for this is not validated and may be null. If using the Create Lead building block script, the P_DESCRIPTION value is set by an answer in a panel within the Gather_Required_ Lead_Data group. |
| p_interest_type_id | P_INTEREST_TYPE_ID | Identifies the Interest Type for which the lead is being created. This is a required value, and it must be a valid INTEREST_TYPE_ID from the AS_ INTEREST_TYPES_V table. If using the Create Lead building block script, the P_INTEREST_TYPE_ID is set by a query that allows the user to select an interest type from a drop down menu in a panel in the Gather_Required_Lead_Data group. |
| p_primary_interest_ code_id | P_PRIMARY_INTEREST_ CODE_ID | Identifies the specific item, or interest code, for which the lead is being created. This is a required value, and it must be a valid INTEREST_CODE_ID from the AS_INTEREST_CODES_V table. If using the Create Lead building block script, the P_PRIMARY_INTEREST_CODE_ID is set by a query that allows the user to select an interest code from a drop down menu in a panel in the Gather_ Required_Lead_Data group. |
| p_project_name | P_PROJECT_NAME | Identifies the project name the customer uses to describe the initiative. This value is not validated and can be null. If using the Create Lead building block script, the P_PROJECT_NAME is set by an answer in a panel in the Gather_Required_Lead_ Data group. |
| p_secondary_interest_ code_id | P_SECONDARY_INTEREST_ CODE_ID | Not required and may be null. Identifies the Interest Type for which the lead is being created - and this is referenced a secondary product interest. If this parameter is set to a non-null value, it must be a valid INTEREST_TYPE_ID from the AS_INTEREST_TYPES_V table. If using the Create Lead building block script, the P_SECONDARY_ INTEREST_CODE_ID is set by a query that allows the user to select an interest type from a drop down menu in a panel in the Gather_Required_Lead_Data group. |
| p_source_promotion_id | P_SOURCE_PROMOTION_ ID | The source code for this lead. This value must be a valid SOURCE_CODE_ID in the AMS_SOURCE_ CODES table. If using the Create Lead building block script, the P_SOURCE_PROMOTION_ID value is set by a an answer in a panel within the Gather_Required_Lead_Data group. |
| p_status_code | Constant | Constant; leave the value already defined by the script. |
| p_user_name | IES_FND_USER_NAME | Agent login name for the individual running the script or survey. This is a required field, but it does not need to be changed, as the IES_FND_USER_ NAME is automatically set. If the script is executed via a survey, this is the Guest User login (JTF Guest User, as described in the Oracle Scripting Implementation Guide). |
Output Parameters
The parameters retrieved are as follows:
| Parameter | Blackboard Key Name | Description |
|---|---|---|
| x_return_status | x_return_status | S - Success E - Error U - Unexpected error |
| x_sales_lead_id | x_sales_lead_id | The sales lead ID returned for a successful execution of the API. |
This command creates an opportunity for an Oracle Telesales lead.
Prerequisites
An Oracle Telesales lead must already exist in order to create an opportunity for a lead.
Package Name
IES_TELESALES_BP_PKG.create_opp_for_lead
Associated Building Block Script Name
ieslead.scr (Create Lead building block script)
Input Parameters
The parameters passed by this seeded command are as follows:
| Parameter | Blackboard Key Name | Description |
|---|---|---|
| p_api_version | Constant | The version number for the API. This value is pre-set and does not need to be changed. |
| p_sales_lead_id | N/A | N/A |
| p_budget_status_code | P_BUDGET_STATUS_CODE | The status of the budget. This must be a valid BUDGET_STATUS in the AMS_LOOKUPS table. If using the Create Lead building block script, the P_ BUDGET_AMOUNT value is set by an answer in a panel within the Gather_Required_Lead_Data group. |
| p_channel_code | Constant | A channel code associated with the lead. This parameter is assigned a value in the reusable command and should not be changed. |
| p_contact_id | CONTACT_ID | The CONTACT_ID which identifies the person within the organization for whom the lead is being created. This must be a valid contact, and it is associated with the Party_ID. If the script using the reusable command has been called by OracleTelesales or Collections, this value is passed into the script with a Blackboard Name of CONTACT_ID. If the script has been called by Oracle Teleservice, the value of the CONTACT_ID can be retrieved by using the Forms command GetContactId and assigning its value as a constant for this parameter. If you are using the Create Lead building block script, the script checks to see if a CONTACT_ID has been passed by the calling application. If the value is null, it looks up the CONTACT_ID based on the PARTY_ID passed into the script. Otherwise, it provides a query allowing you to select the Contact person. Though it references the blackboard key CONTACT_ID, it is passing Null since CONTACT_ ID is never set. |
| p_currency_code | Constant - USD | A currency code. This value is pre-set and does not need to be changed. |
| p_customer_id | PARTY_ID | The Party_ID which identifies the organization with which this lead is associated. This value is required, and it must reference a valid organization. When a script is invoked by Oracle Telesales or Collections, this value is supplied as the PARTY_ID Blackboard Name. If the script has been called by Oracle Teleservice, the value of the PARTY_ID can be retrieved by using the Forms command GetCustomerId and assigning its value as a constant for this parameter. |
| p_decision_timeframe_ code | P_DECISION_TIMEFRAME_ CODE | The time frame in which the customer/prospect expects to purchase the product for which the lead is being created. This value must be a valid DECISION_TIMEFRAME in the AS_LOOKUPS table. If using the Create Lead building block script, the P_DECISION_TIMEFRAME_CODE value is set by a an answer in a panel within the Gather_ Required_Lead_Data group. |
| p_description | P_DESCRIPTION | A description of the project for which the lead is being created. The value for this is not validated and may be null. If using the Create Lead building block script, the P_DESCRIPTION value is set by an answer in a panel within the Gather_Required_ Lead_Data group. |
| p_interest_type_id | P_INTEREST_TYPE_ID | Identifies the Interest Type for which the lead is being created. This is a required value, and it must be a valid INTEREST_TYPE_ID from the AS_ INTEREST_TYPES_V table. If using the Create Lead building block script, the P_INTEREST_TYPE_ID is set by a query that allows the user to select an interest type from a drop down menu in a panel in the Gather_Required_Lead_Data group. |
| p_primary_interest_ code_id | P_PRIMARY_INTEREST_ CODE_ID | Identifies the specific item, or interest code, for which the lead is being created. This is a required value, and it must be a valid INTEREST_CODE_ID from the AS_INTEREST_CODES_V table. If using the Create Lead building block script, the P_PRIMARY_INTEREST_CODE_ID is set by a query that allows the user to select an interest code from a drop down menu in a panel in the Gather_ Required_Lead_Data group. |
| p_project_name | P_PROJECT_NAME | Identifies the project name the customer uses to describe the initiative. This value is not validated and can be null. If using the Create Lead building block script, the P_PROJECT_NAME is set by an answer in a panel in the Gather_Required_Lead_ Data group. |
| p_secondary_interest_ code_id | P_SECONDARY_INTEREST_ CODE_ID | Not required and may be null. Identifies the Interest Type for which the lead is being created - and this is referenced a secondary product interest. If this parameter is set to a non-null value, it must be a valid INTEREST_TYPE_ID from the AS_INTEREST_TYPES_V table. If using the Create Lead building block script, the P_SECONDARY_ INTEREST_CODE_ID is set by a query that allows the user to select an interest type from a drop down menu in a panel in the Gather_Required_Lead_Data group. |
| p_source_promotion_id | P_SOURCE_PROMOTION_ ID | The source code for this lead. This value must be a valid SOURCE_CODE_ID in the AMS_SOURCE_ CODES table. If using the Create Lead building block script, the P_SOURCE_PROMOTION_ID value is set by a an answer in a panel within the Gather_Required_Lead_Data group. |
| p_status_code | Constant | Constant; leave the value already defined by the script. |
| p_user_name | IES_FND_USER_NAME | Agent login name for the individual running the script or survey. This is a required field, but it does not need to be changed, as the IES_FND_USER_ NAME is automatically set. If the script is executed via a survey, this is the Guest User login (JTF Guest User, as described in the Oracle Scripting Implementation Guide). |
Output Parameters
The parameters retrieved are as follows:
| Parameter | Blackboard Key Name | Description |
|---|---|---|
| x_msg_count | x_msg_count | Tells the number of error messages in the message stack. |
| x_msg_data | x_msg_data | A concatenated error message. |
| x_return_status | x_return_status | S - Success E - Error U - Unexpected error |
| x_sales_lead_id | x_sales_lead_id | The sales lead ID returned for a successful execution of the API. |
This command creates a Fulfillment Request for Oracle One-to-One Fulfillment, identifying the collateral that should be sent, the e-mail address to which it must be sent, and the subject of the message. Upon executing this API, One-to-One Fulfillment returns a Fulfillment Request ID, which can be used to track the status of the fulfillment request. One-to-One Fulfillment is actually responsible for processing the collateral request.
Prerequisites
None
Package Name
IES_TELESALES_BP_PKG.SUBMIT_COLLATERAL_TO_FM
Associated Building Block Script Name
iescltrl.scr (Create Collateral building block)
Input Parameters
The parameters passed by this seeded command are as follows:
| Parameter | Blackboard Key Name | Description |
|---|---|---|
| p_api_version | Constant | The version number for the API. This value is pre-set and does not need to be changed. |
| p_deliverable_id | P_DELIVERABLE_ID | P_DELIVERABLE_ID Provides a valid collateral identifier, which must be a valid DELIVERABLE_ID from the AMS_ DELIVERABLES_VL table. If you are using the Create Collateral building block script, the value for this blackboard key name is obtained by allowing the user to select from a drop down menu that displays a list of AMS_DELIVERABLE_NAME values. When the user selects the Deliverable based on its name, the script provides the P_ DELIVERABLE_ID. |
| p_email | P_EMAIL | Provides the e-mail address for the recipient. There must be a valid e-mail address in this field. If you are using the Create Collateral building block script, the P_EMAIL blackboard key name is assigned a default value of the e-mail address stored in HZ_ CONTACT_POINT.EMAIL_ADDRESS. If no e-mail address is stored in this table, then the building block displays a blank value. |
| p_party_id | CONTACT_ID | The CONTACT_ID which identifies the person within the organization for whom the lead is being created. This must be a valid contact, and it is associated with the Party_ID. If the script using the reusable command has been called by OracleTelesales or Collections, this value is passed into the script with a Blackboard Name of CONTACT_ID. If the script has been called by Oracle Teleservice, the value of the CONTACT_ID can be retrieved by using the Forms command GetContactId and assigning its value as a constant for this parameter. If you are using the Create Lead building block script, the script checks to see if a CONTACT_ID has been passed by the calling application. If the value is null, it looks up the CONTACT_ID based on the PARTY_ID passed into the script. Otherwise, it provides a query allowing you to select the Contact person. |
| p_subject | P_SUBJECT | Subject line of the e-mail message sent with the collateral attachment. This is a required field. If the Create Collateral building block script is used, this value is prompted for within the script. |
| p_user_name | IES_FND_USER_NAME | Agent login name for the individual running the script or survey. This is a required field, but it does not need to be changed, as the IES_FND_USER_ NAME is automatically set. If the script is executed via a survey, this is the Guest User login (JTF Guest User, as described in the Oracle Scripting Implementation Guide). |
| p_user_note | P_USER_NOTE | The text of a note that is appended within the e-mail message sent with the collateral attachment. This is not required and the value may be null. If the Create Collateral building block script is used, this value is prompted for within the script. |
Output Parameters
The parameters retrieved are as follows:
| Parameter | Blackboard Key Name | Description |
|---|---|---|
| x_msg_count | x_msg_count | Tells the number of error messages in the message stack. |
| x_msg_data | x_msg_data | A concatenated error message. |
| x_request_id | x_request_id | Fulfillment request ID that is returned from One to One Fulfillment. You can use this request ID to monitor the status of the request from the Fulfillment Admin Console |
| x_return_status | x_return_status | S - Success E - Error U - Unexpected error |
Registers a customer or prospect for an Oracle Marketing Event. When the API is successfully executed, it returns the Event Confirmation number and an Event ID.
Prerequisites
None
Package Name
IES_TELESALES_BP_PKG.register_for_event
Associated Building Block Script Name
iesevent.scr (Event Registration building block)
Input Parameters
The parameters passed by this seeded command are as follows:
| Parameter | Blackboard Key Name | Description |
|---|---|---|
| p_api_version | Constant | The version number for the API. This value is pre-set and does not need to be changed. |
| p_application_id | Constant | The version number for the API. This value is pre-set and does not need to be changed. |
| p_attendant_contact_id | PARTY_CONTACT_ID | Required field. The ORG CONTACT ID off the contact in the HZ_CONTACT_ORG_CONTACTS table. When using the Event Registration building block, this value is automatically retrieved. |
| p_attendant_party_id | CONTACT_ID | Required field. The CONTACT_ID which identifies the person within the organization for whom the lead is being created. This must be a valid contact, and it is associated with the Party_ID. If the script using the reusable command has been called by OracleTelesales or Collections, this value is passed into the script with a Blackboard Name of CONTACT_ID. If the script has been called by Oracle Teleservice, the value of the CONTACT_ID can be retrieved by using the Forms command GetContactId and assigning its value as a constant for this parameter. If you are using the Create Lead building block script, the script checks to see if a CONTACT_ID has been passed by the calling application. If the value is null, it looks up the CONTACT_ID based on the PARTY_ID passed into the script. Otherwise, it provides a query allowing you to select the Contact person. |
| p_event_offer_id | P_EVENT_OFFER_ID | Required field. A valid EVENT_OFFER_ID from the AMS_EVENT_OFFERS_VL table. If using the Event Registration Building block, the value for P_ EVENT_OFFER_ID is retrieved from a query which displays a drop down menu of all EVENT_OFFER_ NAMES. When the user select the event, the P_ EVENT_OFFER_ID is set. |
| p_registrant_contact_id | PARTY_CONTACT_ID | Required field. It is set in the manner described for the PARTY_CONTACT_ID blackboard key name above. |
| p_registrant_party_id | p_registrant_party_id CONTACT_ID | Required field. It is set in the manner described for the CONTACT_ID blackboard key name above. |
| p_source_code | P_SOURCE_CODE | Required field. A valid source code from the AMS_ SOURCE_CODES table. If using the Event Registration building block, the value for P_ SOURCE_CODE is retrieved by a query of all SOURCE_CODES in the AMS_SOURCE_CODES table, and the user is able to select the value from the table. |
| p_user_name | IES_FND_USER_NAME | Agent login name for the individual running the script or survey. This is a required field, but it does not need to be changed, as the IES_FND_USER_ NAME is automatically set. If the script is executed via a survey, this is the Guest User login (JTF Guest User, as described in the Oracle Scripting Implementation Guide). |
Output Parameters
The parameters retrieved are as follows:
| Parameter | Blackboard Key Name | Description |
|---|---|---|
| x_return_status | x_return_status | S - Success E - Error U - Unexpected error |
| x_system_status_code | x_system_status_code | A system status code. |
Creates an interest at an Organization (party) level. Can provide up to two interest codes.
Prerequisites
None
Package Name
None
Associated Building Block Script Name
iesinto.scr (Register Interest for Organization building block)
Input Parameters
The parameters passed by this seeded command are as follows:
| Parameter | Blackboard Key Name | Description |
|---|---|---|
| p_api_version | Constant | The version number for the API. This value is pre-set and does not need to be changed. |
| p_interest_type_id | P_INTEREST_TYPE_ID | Required field. A valid INTEREST_TYPE_ID from the AS_INTEREST_TYPES_V table. If using the Register Interest for Organization building block script, the value for P_INTEREST_TYPE_ID is provided by a query of this table. The user selects a INTEREST_TYPE, and the script provides the associated INTEREST_TYPE_ID as P_INTEREST_ TYPE_ID. |
| p_party_id | PARTY_ID | Required field. This is the PARTY_ID corresponding to the Organization from which the contact was selected. This value is required, and it must reference a valid organization. When a script is invoked by Oracle Telesales or Collections, this value is supplied as the PARTY_ID Blackboard Name. If the script has been called by Oracle Teleservice, the value of the PARTY_ID can be retrieved by using the Forms command GetCustomerId and assigning its value as a constant for this parameter. |
| p_party_site_id | P_PARTY_SITE_ID | Required field. The party site associated with the contact. The P_PARTY_SITE_ID is automatically populated by the Register Interest for Organization building block script. |
| p_party_type | Constant | The type of party for which the interest is being created. This value is pre-filled and should not be changed. |
| p_primary_interest_ code_id | P_PRIMARY_INTEREST_ CODE_ID | Required field. A valid INTEREST_CODE_ID from the AS_INTEREST_TYPES_V table. If using the Register Interest for Organization building block script, the value for P_INTEREST_TYPE_ID is provided by a query of this table. The user selects an INTEREST_CODE, and the script provides the associated P_PRIMARY_INTEREST_CODE_ID as P_PRIMARY_INTEREST_CODE_ID. |
| p_secondary_interest_ code_id | P_SECONDARY_INTEREST_ CODE_ID | Not required and may be null. If this parameter is set to a non-null value, it must have valid INTEREST_CODE_ID from the AS_INTEREST_ TYPES_V table. If using the Register Interest for Organization building block script, the value for P_ INTEREST_TYPE_ID is provided by a query of this table. The user selects an INTEREST_CODE, and the script provides the associated P_SECONDARY_ INTEREST_CODE_ID as P_SECONDARY_ INTEREST_CODE_ID. |
| p_user_name | IES_FND_USER_NAME | Agent login name for the individual running the script or survey. This is a required field, but it does not need to be changed, as the IES_FND_USER_ NAME is automatically set. If the script is executed via a survey, this is the Guest User login (JTF Guest User, as described in the Oracle Scripting Implementation Guide). |
Output Parameters
The parameters retrieved are as follows:
| Parameter | Blackboard Key Name | Description |
|---|---|---|
| x_interest_id | x_interest_id | A confirmation number when the API executes successfully. |
| x_msg_count | x_msg_count | Tells the number of error messages in the message stack. |
| x_msg_data | x_msg_data | A concatenated error message. |
| x_return_status | x_return_status | S - Success E - Error U - Unexpected error |
| x_system_status_code | x_system_status_code | A system status code. |
Registers an interest for a contact.
Prerequisites
None
Package Name
ies_create_interest_contact
Associated Building Block Script Name
iesintc.scr (Register Interest for Contact building block)
Input Parameters
The parameters passed by this seeded command are as follows:
| Parameter | Blackboard Key Name | Description |
|---|---|---|
| p_api_version | Constant | The version number for the API. This value is pre-set and does not need to be changed. |
| p_interest_type_id | P_INTEREST_TYPE_ID | Required field. A valid INTEREST_TYPE_ID from the AS_INTEREST_TYPES_V table. If using the Register Interest for Organization building block script, the value for P_INTEREST_TYPE_ID is provided by a query of this table. The user selects a INTEREST_TYPE, and the script provides the associated INTEREST_TYPE_ID as P_INTEREST_ TYPE_ID. |
| p_org_contact_id | PARTY_CONTACT_ID | Required field. The ORG CONTACT ID off the contact in the HZ_CONTACT_ORG_CONTACTS table. When using the Event Registration building block, this value is automatically retrieved. |
| p_party_id | PARTY_ID | Required field. This is the PARTY_ID corresponding to the Organization from which the contact was selected. This value is required, and it must reference a valid organization. When a script is invoked by Oracle Telesales or Collections, this value is supplied as the PARTY_ID Blackboard Name. If the script has been called by Oracle Teleservice, the value of the PARTY_ID can be retrieved by using the Forms command GetCustomerId and assigning its value as a constant for this parameter. |
| p_party_site_id | P_PARTY_SITE_ID | Required field. The party site associated with the contact. The P_PARTY_SITE_ID is automatically populated by the Register Interest for Organization building block script. |
| p_party_type | Constant | The type of party for which the interest is being created. This value is pre-filled and should not be changed. |
| p_primary_interest_ code_id | P_PRIMARY_INTEREST_ CODE_ID | Required field. A valid INTEREST_CODE_ID from the AS_INTEREST_TYPES_V table. If using the Register Interest for Organization building block script, the value for P_INTEREST_TYPE_ID is provided by a query of this table. The user selects an INTEREST_CODE, and the script provides the associated P_PRIMARY_INTEREST_CODE_ID as P_PRIMARY_INTEREST_CODE_ID. |
| p_secondary_interest_ code_id | P_SECONDARY_INTEREST_ CODE_ID | Not required and may be null. If this parameter is set to a non-null value, it must have valid INTEREST_CODE_ID from the AS_INTEREST_ TYPES_V table. If using the Register Interest for Organization building block script, the value for P_ INTEREST_TYPE_ID is provided by a query of this table. The user selects an INTEREST_CODE, and the script provides the associated P_SECONDARY_ INTEREST_CODE_ID as P_SECONDARY_ INTEREST_CODE_ID. |
| p_user_name | IES_FND_USER_NAME | Agent login name for the individual running the script or survey. This is a required field, but it does not need to be changed, as the IES_FND_USER_ NAME is automatically set. If the script is executed via a survey, this is the Guest User login (JTF Guest User, as described in the Oracle Scripting Implementation Guide). |
Output Parameters
The parameters retrieved are as follows:
| Parameter | Blackboard Key Name | Description |
|---|---|---|
| x_interest_id | x_interest_id | A confirmation number when the API executes successfully. |
| x_msg_count | x_msg_count | Tells the number of error messages in the message stack. |
| x_msg_data | x_msg_data | A concatenated error message. |
| x_return_status | x_return_status | S - Success E - Error U - Unexpected error |
Creates a contact for an organization.
Prerequisites
None
Package Name
IES_TCA_BP_PKG.create_org_contact
Associated Building Block Script Name
iescustr.scr (Retrieve Existing Contact Within an Organization building block. This script creates a contact (name and address information), a party, a party location, and an organization type in the TCA schema.
Input Parameters
The parameters passed by this seeded command are as follows:
| Parameter | Blackboard Key Name | Description |
|---|---|---|
| p_api_version | Constant | The version number for the API. This value is pre-set and does not need to be changed. |
| p_interest_type_id | P_INTEREST_TYPE_ID | Required field. A valid INTEREST_TYPE_ID from the AS_INTEREST_TYPES_V table. If using the Register Interest for Organization building block script, the value for P_INTEREST_TYPE_ID is provided by a query of this table. The user selects a INTEREST_TYPE, and the script provides the associated INTEREST_TYPE_ID as P_INTEREST_ TYPE_ID. |
| p_content_source_type | Constant | Required field. If using the building block script iescustr.scr, this is defined as a Constant that is set to an original value of USER_ENTERED. |
| p_org_party_id | x_party_id | Required field. The Party_ID of the organization to whom this contact is attached.If using the building block script iescustr.scr, this is set to the blackboard value for the blackboard key name of x_party_id. The blackbody key of x_party_id is set as a Post Action in the panel called Collect Org Details, as the return parameter on the reusable command ies_ create_party_org_type. |
| p_party_relationship_ type | Constant | Required field. If using the building block script iescustr.scr, this is defined as a Constant with a value of CONTACT_OF. |
| p_party_site_id | x_party_site_id | Required field. The party site associated with the contact.If using the building block script iescustr.scr, this is set to the value of the blackboard key of x_ party_site_id. The blackboard key for x_party_site_ id is set by the Post Action on the group called Create Party Site, which invokes the reusable command ies_create_party_site. |
| p_person_party_id | x_person_party_id | Required field. If using the building block scripts iescustr.scr, this is set to the Blackboard value for the blackboard key name x_person_party_id. The blackboard key of _person_party_id is set by the panel called Collect Person Info in the Post Action which calls the reusable command ies_create_ person_party. |
| p_user_name | IES_FND_USER_NAME | Agent login name for the individual running the script or survey. This is a required field, but it does not need to be changed, as the IES_FND_USER_ NAME is automatically set. If the script is executed via a survey, this is the Guest User login (JTF Guest User, as described in the Oracle Scripting Implementation Guide). |
Output Parameters
The parameters retrieved are as follows:
| Parameter | Blackboard Key Name | Description |
|---|---|---|
| x_msg_count | x_msg_count | Tells the number of error messages in the message stack. |
| x_msg_data | x_msg_data | A concatenated error message. |
| x_org_contact_id | x_org_contact_id | The Organization Contact ID of the organization created by successful completion of this reusable command. |
| x_party_rel_id | x_party_rel_id | The Party Relationship ID of the party created by successful completion of this reusable command. |
| x_rel_party_id | x_rel_party_id | The Relationship Party ID created by successful completion of this reusable command. |
| x_rel_party_number | x_rel_party_number | The Relationship Party Number created by successful completion of this reusable command. |
| x_return_status | x_return_status | S - Success E - Error U - Unexpected error |
Creates a party organization type.
Prerequisites
None
Package Name
IES_TCA_BP_PKG.create_organization
Associated Building Block Script Name
iescustr.scr (Retrieve Existing Contact Within an Organization building block. This script creates a contact (name and address information), a party, a party location, and an organization type in the TCA schema.
Input Parameters
The parameters passed by this seeded command are as follows:
| Parameter | Blackboard Key Name | Description |
|---|---|---|
| p_api_version | Constant | The version number for the API. This value is pre-set and does not need to be changed. |
| p_content_source_type | Constant | Required field. If using the building block script iescustr.scr, this is defined as a Constant that is set to an original value of USER_ENTERED. |
| p_org_name | P_ORG_NAME | Required field. The name of the Organization being created.If using the building block script iescustr.scr, this blackboard key value is defined as the answer to a question in the panel called Collect Org Details. |
| p_party_relationship_ type | Constant | Required field. If using the building block script iescustr.scr, this is defined as a Constant with a value of CONTACT_OF. |
| p_user_name | IES_FND_USER_NAME | Agent login name for the individual running the script or survey. This is a required field, but it does not need to be changed, as the IES_FND_USER_ NAME is automatically set. If the script is executed via a survey, this is the Guest User login (JTF Guest User, as described in the Oracle Scripting Implementation Guide). |
Output Parameters
The parameters retrieved are as follows:
| Parameter | Blackboard Key Name | Description |
|---|---|---|
| x_msg_count | x_msg_count | Tells the number of error messages in the message stack. |
| x_msg_data | x_msg_data | A concatenated error message. |
| x_party_id | x_party_id | The Party ID for the record created upon successful completion of this reusable command. |
| x_party_number | x_party_number | The Party Number for the record created upon successful completion of this reusable command. |
| x_profile_id | x_profile_id | The Profile ID for the record created upon successful completion of this reusable command. |
Creates a party site.
Prerequisites
None
Package Name
IES_TCA_BP_PKG.create_party_site
Associated Building Block Script Name
iescustr.scr (Retrieve Existing Contact Within an Organization building block. This script creates a contact (name and address information), a party, a party location, and an organization type in the TCA schema.
Input Parameters
The parameters passed by this seeded command are as follows:
| Parameter | Blackboard Key Name | Description |
|---|---|---|
| p_api_version | Constant | The version number for the API. This value is pre-set and does not need to be changed. |
| p_location_id | x_location_id | Required field. If using the building block script iescustr.scr, this is set to the Blackboard value for the blackboard key name of x_location_id. The blackboard key of x_location_id is set as a Post Action in the Group called Create Location, upon successful completion of the reusable command ies_ create_location. |
| p_party_id | x_party_id | Required field. The Party_ID of the organization to whom this contact is attached. If using the building block script iescustr.scr, this is set to the blackboard value for the blackboard key name of x_party_id. The blackboard key of x_party_id is set as a Post Action in the panel called Collect Org Details, as the return parameter on the reusable command ies_ create_party_org_type. |
| p_user_name | IES_FND_USER_NAME | Agent login name for the individual running the script or survey. This is a required field, but it does not need to be changed, as the IES_FND_USER_ NAME is automatically set. If the script is executed via a survey, this is the Guest User login (JTF Guest User, as described in the Oracle Scripting Implementation Guide). |
Output Parameters
The parameters retrieved are as follows:
| Parameter | Blackboard Key Name | Description |
|---|---|---|
| x_msg_count | x_msg_count | Tells the number of error messages in the message stack. |
| x_msg_data | x_msg_data | A concatenated error message. |
| x_party_site_id | x_party_site_id | The Party Site ID for the record created upon successful completion of the reusable command |
| x_party_site_number | x_party_site_number | The Party Site Number for the record created upon successful completion of this reusable command. |
| x_return_status | x_return_status | S - Success E - Error U - Unexpected error |
Creates a person/contact for an organization, setting the name and time, and retrieving the ID for the contact.
Prerequisites
None
Package Name
IES_TCA_BP_PKG.create_person
Associated Building Block Script Name
iescustr.scr (Retrieve Existing Contact Within an Organization building block. This script creates a contact (name and address information), a party, a party location, and an organization type in the TCA schema.
Input Parameters
The parameters passed by this seeded command are as follows:
| Parameter | Blackboard Key Name | Description |
|---|---|---|
| p_api_version | Constant | The version number for the API. This value is pre-set and does not need to be changed. |
| p_content_source_type | Constant | Required field.If using the building block script iescustr.scr, this is defined as a Constant that is set to an original value of USER_ENTERED. |
| p_first_name | P_FIRST_NAME | Required field. The first name of the individual. If using the building block script iescustr.scr, this blackboard key is defined as the answer to a question in the panel called Collect Person Info. |
| p_last_name | P_LAST_NAME | Required field. The last name of the individual. If using the building block script iescustr.scr, this blackboard key is defined as the answer to a question in the panel called Collect Person Info. |
| p_middle_name | P_MIDDLE_NAME | Required field. The middle name of the individual. If using the building block script iescustr.scr, this blackboard key is defined as the answer to a question in the panel called Collect Person Info. |
| p_title | P_TITLE | Required field. The title (Mr., Mrs., Ms, etc.) of the individual. If using the building block script iescustr.scr, this blackboard key is defined as the answer to a question in the panel called Collect Person Info. |
| p_user_name | IES_FND_USER_NAME | Agent login name for the individual running the script or survey. This is a required field, but it does not need to be changed, as the IES_FND_USER_ NAME is automatically set. If the script is executed via a survey, this is the Guest User login (JTF Guest User, as described in the Oracle Scripting Implementation Guide). |
Output Parameters
The parameters retrieved are as follows:
| Parameter | Blackboard Key Name | Description |
|---|---|---|
| x_msg_count | x_msg_count | Tells the number of error messages in the message stack. |
| x_msg_data | x_msg_data | A concatenated error message. |
| x_party_number | x_party_number | The Party Number for the record created upon successful completion of this reusable command. |
| x_party_site_number | x_party_site_number | The Party Site Number for the record created upon successful completion of this reusable command. |
| x_profile_id | x_profile_id | The profile ID for the record created upon successful completion of this reusable command. |
| x_return_status | x_return_status | S - Success E - Error U - Unexpected error |
Creates a location for a contact, setting the contact's address information, and retrieving the ID for the location.
Prerequisites
None
Package Name
IES_TCA_BP_PKG.create_location
Associated Building Block Script Name
iescustr.scr (Retrieve Existing Contact Within an Organization building block. This script creates a contact (name and address information), a party, a party location, and an organization type in the TCA schema.
Input Parameters
The parameters passed by this seeded command are as follows:
| Parameter | Blackboard Key Name | Description |
|---|---|---|
| p_api_version | Constant | The version number for the API. This value is pre-set and does not need to be changed. |
| p_address1 | P_ADDRESS1 | Required field. If using the building block script iescustr.scr, this is defined as a blackboard key in the panel called Collect Person Info. |
| p_address2 | P_ADDRESS2 | Required field. If using the building block script iescustr.scr, this is defined as a blackboard key in the panel called Collect Person Info. |
| p_address3 | P_ADDRESS3 | Required field. If using the building block script iescustr.scr, this is defined as a blackboard key in the panel called Collect Person Info. |
| p_address4 | P_ADDRESS4 | Required field. If using the building block script iescustr.scr, this is defined as a blackboard key in the panel called Collect Person Info. |
| p_city | P_CITY | Required field. If using the building block script iescustr.scr, this is defined as a blackboard key in the panel called Collect Person Info. |
| p_postal_code | P_POSTAL_CODE | Required field. If using the building block script iescustr.scr, this is defined as a blackboard key in the panel called Collect Person Info. |
| p_province | P_PROVINCE | Required field. If using the building block script iescustr.scr, this is defined as a blackboard key in the panel called Collect Person Info. |
| p_state | P_STATE | Required field. If using the building block script iescustr.scr, this is defined as a blackboard key in the panel called Collect Person Info. |
| p_country | P_COUNTRY | Required field. If using the building block script iescustr.scr, this is defined as a blackboard key in the panel called Collect Person Info. |
| p_user_name | IES_FND_USER_NAME | Agent login name for the individual running the script or survey. This is a required field, but it does not need to be changed, as the IES_FND_USER_ NAME is automatically set. If the script is executed via a survey, this is the Guest User login (JTF Guest User, as described in the Oracle Scripting Implementation Guide). |
Output Parameters
The parameters retrieved are as follows:
| Parameter | Blackboard Key Name | Description |
|---|---|---|
| x_msg_count | x_msg_count | Tells the number of error messages in the message stack. |
| x_msg_data | x_msg_data | A concatenated error message. |
| x_location_id | x_location_id | The location ID for the record created upon successful completion of this reusable command. |
| x_return_status | x_return_status | S - Success E - Error U - Unexpected error |
Updates the contact information for a contact in an organization.
Prerequisites
Contact information for an organization must already exist.
Package Name
IES_TCA_BP_PKG.update_org_contact
Associated Building Block Script Name
iesupdct.scr (Update Contact Information building block). This script retrieves an existing contact within an organization, then allows the user to update the contact name and address information.
Input Parameters
The parameters passed by this seeded command are as follows:
| Parameter | Blackboard Key Name | Description |
|---|---|---|
| p_api_version | Constant | The version number for the API. This value is pre-set and does not need to be changed. |
| p_org_contact_id | P_ORG_CONTACT_ID | Required field. If using the building block script iesupdct.scr, this is set to the Blackboard value for the blackboard key name of PARTY_CONTACT_ID. The blackboard key of PARTY_CONTACT_ID retrieved in the Group Get_Party_And_Contact_ Information. |
| p_party_site_id | x_party_site_id | Required field. The party site associated with the contact.If using the building block script iescustr.scr, this is set to the value of the blackboard key of x_ party_site_id. The blackboard key for x_party_site_ id is set by the Post Action on the group called Create Party Site, which invokes the reusable command ies_create_party_site. |
| p_user_name | IES_FND_USER_NAME | Agent login name for the individual running the script or survey. This is a required field, but it does not need to be changed, as the IES_FND_USER_ NAME is automatically set. If the script is executed via a survey, this is the Guest User login (JTF Guest User, as described in the Oracle Scripting Implementation Guide). |
Output Parameters
The parameters retrieved are as follows:
| Parameter | Blackboard Key Name | Description |
|---|---|---|
| x_msg_count | x_msg_count | Tells the number of error messages in the message stack. |
| x_msg_data | x_msg_data | A concatenated error message. |
| x_return_status | x_return_status | S - Success E - Error U - Unexpected error |
Updates the contact information for a contact in an organization.
Prerequisites
A contact in an organization must already exist. Package Name IES_TCA_BP_PKG.update_party_site
Associated Building Block Script Name
iesupdct.scr (Update Existing Contact Within an Organization building block). This script retrieves an existing contact within an organization, then allows the user to update the contact name and address information
Input Parameters
The parameters passed by this seeded command are as follows:
| Parameter | Blackboard Key Name | Description |
|---|---|---|
| p_api_version | Constant | The version number for the API. This value is pre-set and does not need to be changed. |
| p_party_site_id | P_PARTY_SITE_ID | Required field. The Party_Site_ID of the organization to whom this contact is attached. If using the building block script iesupdct.scr, this is set to the blackboard value for the blackboard key name of P_PARTY_SITE_ID. The blackboard key of P_PARTY_SITE_ID is set in the group Get_Party_ And_Contact_Information. |
| p_user_name | IES_FND_USER_NAME | Agent login name for the individual running the script or survey. This is a required field, but it does not need to be changed, as the IES_FND_USER_ NAME is automatically set. If the script is executed via a survey, this is the Guest User login (JTF Guest User, as described in the Oracle Scripting Implementation Guide). |
Output Parameters
The parameters retrieved are as follows:
| Parameter | Blackboard Key Name | Description |
|---|---|---|
| x_msg_count | x_msg_count | Tells the number of error messages in the message stack. |
| x_msg_data | x_msg_data | A concatenated error message. |
| x_return_status | x_return_status | S - Success E - Error U - Unexpected error |