This chapter includes user procedures on basic setups.
This chapter covers the following topics:
The tasks that you perform with system queues are listed below:
The Queue Console displays the following summary information about all system queues.
State (Enabled, Shutdown, Suspended)
Number of entries in the queue
Date that the last entry in the queue occurred
Number of dequeue processors that are registered
Number of processors that are currently running for the queue
To display this information, perform the following steps.
Steps
In the Navigator, choose Administration, then Queue Console. The Queue Console appears.
Select a queue. The View Details button is enabled if there are entries in the queue, else it is disabled.
Click View Details to view additional information about the entries in a queue.
Close the window to return to the Queue Console.
To search for an order that is currently in the queue, perform the following steps.
Steps
In the Navigator, choose Administration, then Queue Console. The Queue Console appears.
Select a queue. The View Details button is enabled if there are entries in the queue, else it is disabled.
Click View Details.
(Optional) Select View, then Query By Example, then Enter from the View menu on the toolbar to find a specific order in the queue, or to find entries that match a search criteria.
(Optional) Enter the search criteria in the provided fields.
Select View, then Query By Example, then Run from the View menu on the toolbar.
Select View, then Query By Example, then Cancel to close the window and return to the Queue Console.
Note: If there are a large number of orders in the queue, this action may take several seconds to complete.
To start all processors of the queue, perform the following steps.
Prerequisites
The queue must be in Shutdown mode to start a queue.
Steps
In the Navigator, choose Administration, then Queue Console. The Queue Console appears.
Select a queue. If the queue is in Shutdown mode, the Startup button is enabled.
Click Startup. The Queue Status changes to Enabled.
To shut down all processors of the queue, perform the following steps.
Prerequisites
The queue must be in either the Enabled or Disabled mode for this option to be available.
Steps
In the Navigator, choose Administration, then Queue Console. The Queue Console appears.
Select a queue that is either in the Enabled or the Disabled mode.
Click Shutdown. The Queue Status changes to Shutdown.
To suspend processing of orders in the queue, perform the following steps.
Prerequisites
The queue must be in either the Enabled or Disabled mode for this option to be available.
Steps
In the Navigator, choose Administration, then Queue Console. The Queue Console appears.
Select a queue that is either in the Enabled or the Shutdown mode. If the queue is in Enabled or Shutdown mode, the Suspend button is enabled.
Click Suspend. The Queue Status changes to Disabled.
To resume processing orders in the queue, perform the following steps.
Prerequisites
The queue must be in the Disabled mode for this option to be available.
Steps
In the Navigator, choose Administration, then Queue Console. The Queue Console appears.
Select a queue that is in the Disabled mode. If the queue is in Disabled mode, the Resume button is enabled.
Click Resume. The Queue Status changes to Enabled.
To view the XML content for a message that is currently in the queue, perform the following steps.
Prerequisites
To view XML message content, you must select either the Outbound Messages queue, the Inbound Messages queue, or the Event queue, and you must have an XML-enabled browser available to display XML messages.
Steps
In the Navigator, choose Administration, then Queue Console. The Queue Console appears.
Select a queue. The View Details button is enabled if there are entries in the queue, else it is disabled.
Click View Details.
Select a message from the list at the left.
Click View XML. If available, the XML messages are displayed in a new window.
The user should be able to define business rules in the following PL/SQL procedures for the selection of work item to execute for a given service, the selection of fulfillment actions to execute for a given work item, and the selection of Oracle Workflow process to execute for a given work item.
During order capturing time, SFM will need to determine which work items to execute for a given service. Sometimes the list of work items to execute for a service is fixed and can be defined by an SFM user during configuration time through the SFM Configurator. Sometimes the list of work items to run can vary depends on certain parameter values in the order during runtime. For example, a company can have a Nortel network and a Lucent network on different geographical areas and the work items for the same service can vary depends on which network it will be provisioned on. SFM provides a solution to such problem by allowing the user to define business logic in the service to work item mapping procedure, where the user can instruct SFM to execute different set of work items base on the actual value of a service parameter, the area code for example. An example will be given later in this chapter.
When defining the service to work item mapping procedure through the Configurator, SFM will automatically generate the following procedure specification:
procedure <name of the procedure>( p_order_id IN NUMBER, p_line_item_id IN NUMBER, p_return_code OUT NUMBER, p_error_description OUT VARCHAR2
The user cannot change the procedure specification. However, the user can refer to the parameters anywhere in the procedure.
During work item execution, SFM will need to determine which Service Fulfillment Manager activities, namely fulfillment actions, need to be executed for a given Service Fulfillment Manager job, namely work item. Sometimes the list of fulfillment actions (FAs) to execute for a work item is fixed and can be defined by an SFM user during configuration time through the SFM Configurator. Sometimes the list of FAs to run can vary depends on certain parameter value in the order during runtime. For example, a work item PROVISION_CARRIER_SWITCH may invoke different FAs depends on the long distance carrier the customer chooses. SFM provides a solution to such problem by allowing the user to define business logic in the work item to FA mapping procedure, where the user can instruct SFM to execute different set of FAs base on the actual value of a service parameter, the carrier code for example.
The Oracle Number Portability application is seeded with a number of fulfillment element types. The following table lists these predefined element types.
| Element Type | Description |
|---|---|
| DIRECTORY_ GATEWAY | Refers to directory assistance gateway |
| NRC_GATEWAY | Refers to the Number Registration Center gateway |
| SCP | Refers to the LNP database for all service control points |
| SP_GATEWAY | Refers to messaging gateways for remote systems of other service providers |
| SSP | Refers to signal switching point |
| STP | Refers to signal transfer point |
When defining the work item to FA mapping procedure through the Configurator, SFM will automatically generate the following procedure specification:
procedure <name of the procedure>( p_order_id IN NUMBER, p_line_item_id IN NUMBER, p_wi_instance_id IN NUMBER, p_return_code OUT NUMBER, p_error_description OUT VARCHAR2)
The user cannot change the procedure specification. However, the user can refer to the parameters anywhere in the procedure.
Sometimes the work item execution can be a really complex process. For example, when a customer orders a T1 circuit, the carrier may need to get a circuit design first, and then provision the appropriate fulfillment elements accordingly. In such case SFM will not be able to determine which FA to execute for this particular work item at the beginning of the Service Fulfillment Manager process due to the fact Element Type Description DIRECTORY_ GATEWAY Refers to directory assistance gateway NRC_GATEWAY Refers to the Number Registration Center gateway SCP Refers to the LNP database for all service control points SP_GATEWAY Refers to messaging gateways for remote systems of other service providers SSP Refers to signal switching point STP Refers to signal transfer point that, the next FA execution is solely base on the execution result of the previous FA. SFM addresses this problem by allowing the user to associate an Oracle Workflow with the work item, where the users can define their own business process flow for the work item execution. In some practice the user may want to define multiple workflow processes for the same work item base on their network implementation. For example, they may have different network configuration on different geographical areas which in turn may require different business process to execute for the same work item. The user can then implement their workflow selection rules in the work item workflow execution procedure, which SFM will use to select the appropriate workflow process base on the order information at runtime.
When defining the work item workflow execution procedure through the Configurator, SFM will automatically generate the following procedure specification:
procedure <name of the procedure>( p_order_id IN NUMBER, p_line_item_id IN NUMBER, p_wi_instance_id IN NUMBER, p_wf_item_type OUT varchar2, p_wf_item_key OUT varchar2, p_wf_process_name OUT varchar2, p_reurn_code OUT NUMBER, p_error_description OUT VARCHAR2)
The user cannot change the procedure specification. However, the user can refer to the parameters anywhere in the procedure.
The user should be able to define business rules in the following PL/SQL procedures for evaluating the parameter value at runtime, identifying which fulfillment element to run against for an FA, and Service Fulfillment Manager a fulfillment element for an FA.
This procedure allows the user to evaluate a work item parameter value at runtime. For example, the user can use this procedure to retrieve value for certain Service Fulfillment Manager specific parameter from systems such as network inventory Considerations for Planning an Implementation Project 1-60 Oracle Service Fulfillment Manager Implementation Guide database, or change the format of the work item parameter value to best fit their business need.
When defining work item parameter evaluation procedure through the Configurator, SFM will automatically generate the following procedure specification:
procedure <name of the procedure>( p_order_id IN NUMBER, p_line_item_id IN NUMBER, p_wi_instance_id IN NUMBER, p_param_valIN Varchar2, p_param_ref_valIN Varchar2, p_param_eval_val OUT VARCHAR2, p_param_eval_ref_val OUT Varchar2, p_return_codeOUT NUMBER, p_error_description OUT VARCHAR2)
The user cannot change the procedure specification. However, the user can refer to the parameters anywhere in the procedure.
This procedure allows the user to evaluate a fulfillment action parameter value at runtime. For example, the user can use this procedure to retrieve value for certain Service Fulfillment Manager specific parameter from systems such as network inventory database, or change the format of the work item parameter value to best fit their business need.
When defining work item parameter evaluation procedure through the Configurator, SFM will automatically generate the following procedure specification:
procedure <name of the procedure>( p_order_id IN NUMBER, p_line_item_id IN NUMBER, p_wi_instance_id IN NUMBER, Considerations for Planning an Implementation Project Implementing Oracle Service Fulfillment Manager 1-61 p_fa_instance_id IN NUMBER, p_param_valIN Varchar2, p_param_ref_valIN Varchar2, p_param_eval_val OUT VARCHAR2, p_param_eval_ref_val OUT Varchar2, p_return_codeOUT NUMBER, p_error_description OUT VARCHAR2)
The user cannot change the procedure specification. However, the user can refer to the parameters anywhere in the procedure.
This procedure allows the user to identify which fulfillment element to provision for a fulfillment action based on the order information at runtime.
When defining fulfillment element routing procedure through the Configurator, SFM will automatically generate the following procedure specification:
procedure <name of the procedure>( p_order_id IN NUMBER, p_line_item_id IN NUMBER, p_wi_instance_id IN NUMBER, p_fa_instance_id IN NUMBER, p_fe_name OUT Varchar2, p_return_codeOUT NUMBER, p_error_description OUT VARCHAR2)
The user cannot change the procedure specification. However, the user can refer to the parameters anywhere in the procedure.
This procedure allows the user to define the Service Fulfillment Manager logic on a particular fulfillment element type for a fulfillment action. The user will be able to use a set of macros provided by SFM to send the appropriate commands or message to the fulfillment element, examine the response from the fulfillment element and determine the next command or message accordingly.
When defining work item parameter evaluation procedure through the Configurator, SFM will automatically generate the following procedure specification:
procedure <name of the procedure>( p_order_id IN NUMBER, p_line_item_id IN NUMBER, p_wi_instance_id IN NUMBER, p_fa_instance_id IN NUMBER, p_channel_nameIN Varchar2, p_fe_nameIN VARCHAR2, p_fa_item_type IN VARCHAR2, p_fa_item_key IN VARCHAR2, sdp_internal_err_codeOUT NUMBER, sdp_internal_err_str OUT VARCHAR2)
The user cannot change the procedure specification. However, the user can refer to the parameters anywhere in the procedure.
Sometimes the communication between SFM and the fulfillment element may require SFM to open a connection to the equipment before passing messages or commands to the FE. This chapter will describe how to implement the connection logic in the connect/disconnect procedure which will be executed by SFM when a communication channel is established between SFM and the fulfillment element.
This procedure allows the user to instruct SFM how to establish a connection to a fulfillment element.
When defining connect procedure through the Configurator, SFM will automatically generate the following procedure specification:
procedure <name of the procedure>( p_fe_name IN Varchar2, p_channel_nameIN Varchar2, p_return_code IN OUT NUMBER, p_error_description IN OUT VARCHAR2)
The user cannot change the procedure specification. However, the user can refer to the parameters anywhere in the procedure.
This procedure allows the user to instruct SFM how to close a connection from a fulfillment element.
When defining connect procedure through the Configurator, SFM will automatically generate the following procedure specification:
procedure <name of the procedure>( p_fe_name IN Varchar2, p_channel_nameIN Varchar2, p_return_code IN OUT NUMBER, p_error_description IN OUT VARCHAR2)
The user cannot change the procedure specification. However, the user can refer to the parameters anywhere in the procedure.
You use the Connection Manager to manage all types of fulfillment elements and their Adapters. The Connection Manager is used to control network connections.
You perform the following tasks using the Connection Manager:
To view the network associated with a fulfillment element, perform the following steps.
Steps
In the Navigator, choose Administration, then Connection Manager. The Connection Manager appears..
Click Enter a filtering value to filter the list of fulfillment elements that display in the left-hand frame.
Conversely, erase the filtered value entry to view all defined fulfillment elements.
Select a fulfillment element from the list.
Select the Adapters tab to view information about adapters.
Select the adapter type to view from the Usage list. You can select from the following options:
All Types
Messaging
Order Resubmission
Service Fulfillment Manager
Testing
Select from the following:
The Adapters sub-tab to view information about the current status of an adapter.
The Options sub-tab to display the adapter display name and arguments for the adapter.
The Modes sub-tab to view information about Startup and Debug modes for an adapter.
The Requests sub-tab to view to view information about how the adapter has been scheduled.
Close the form.
To define a new adapter in the system, perform the following steps.
Steps
In the Navigator, choose Administration, then Connection Manager.
Select the Adapters tab.
Click New to open the Adapter Properties dialog box.
Enter a name for the new adapter.
Select a value from the Usage list.
Select a value from the Startup Mode list.
Select a value from the Debug Mode list.
Click OK to define the new adapter and close the dialog box. The new adapter now displays in the list of adapters.
Warning: You can start a new adapter only if it does not exceed the maximum number of connections allowed (or configured) for that specific fulfillment element.
To edit an adapter definition, perform the following steps.
Prerequisites
The adapter must display a status of Shutdown for this option to be available.
Steps
In the Navigator, choose Administration, then Connection Manager.
Select the adapter from the list at the left.
Select the Adapters tab.
Click Edit. The Adapter Properties dialog box displays.
Edit the details of the adapter
Click OK to redefine the adapter and close the dialog box.
To schedule a request for an adapter, perform the following steps.
Prerequisites
You cannot schedule a request prior to the current date and time.
Steps
In the Navigator, choose Administration, then Connection Manager.
Select the Adapters tab.
Click Schedule... to open the Adapter Request dialog box.
Chose a value from the Request Type list of values.
Chose a date and time for the request to execute the request. (If desired, open the Calendar function by clicking the [...] at the edge of the Date/Time field.)
To issue the request immediately, enter the current date and time.
To postpone the execution of the request, enter a future date.
Enter the period (in days) that the adapter request is to repeat by entering a value in the Repeat Every (days) field. To schedule a request only once, leave this field blank.
Click OK to schedule the request and close the dialog box.
Note: To delete a scheduled request, select it and click Delete.
To delete an adapter from the system, perform the following steps.
Prerequisites
The adapter must display a status of Shutdown for this option to be available.
Steps
In the Navigator, choose Administration, then Connection Manager.
Select the adapter to delete from the list of adapters.
Click Schedule... to open the Adapter Request dialog box.
Click Delete. The adapter no longer displays in the list of adapters.
If an adapter request causes an error condition, the Current Status field for that adapter displays Error.
To view details of the error condition, perform the following steps.
Prerequisites
The adapter must display a status of Error for this option to be available.
Steps
In the Navigator, choose Administration, then Connection Manager.
Select the adapter from the list of adapters at the left.
Select the Adapters tab.
Click Show Error. The time the error message occurred and the text of the error message display.
Click OK to close the Error Message window.
To issue a disconnect request to an adapter, perform the following steps.
Prerequisites
The adapter must display a status of Running for this option to be available.
Steps
In the Navigator, choose Administration, then Connection Manager.
Select the adapter from the list of adapters at the left.
Select the Adapters tab.
Click Disconnect. The status for this adapter now displays Disconnected.
To issue a connect request to an adapter, perform the following steps.
Prerequisites
The adapter must display a status of Disconnected for this option to be available.
Steps
In the Navigator, choose Administration, then Connection Manager.
Select the adapter from the list of adapters at the left.
Select the Adapters tab.
Click Connect. The Current Status field for this adapter now displays Running.
To issue a suspend request to an adapter, perform the following steps.
Prerequisites
The adapter must display a status of Running for this option to be available.
Steps
In the Navigator, choose Administration, then Connection Manager.
Select the adapter from the list of adapters at the left.
Select the Adapters tab.
Click Suspend. The Current Status field for this adapter now displays Suspended.
To issue a resume request to an adapter, perform the following steps.
Prerequisites
The adapter must display a status of Suspended for this option to be available.
Steps
In the Navigator, choose Administration, then Connection Manager.
Select the adapter from the list of adapters at the left.
Select the Adapters tab.
Click Resume. The Current Status field for this adapter now displays Running.
You perform a number of tasks with services. These include:
For the steps and tasks associated with setting up a service, see Configuring Services for an overview of the processes involved.
The tasks necessary to configure a service are described in the following steps.
Steps
In configuring services, you must define all of the following items.
| Item | See |
|---|---|
| The details of the service (for example, version, description and activation dates) | Defining a New Service |
| The actions available for a specific service and version | Associating Actions with a Service |
| The work items used by the service actions | Associating Work Items with Service Actions |
Services are also referred to as products or service offerings. In each case, however, they represent services deployed by a service provider who delivers, activates, maintains and bills a subscriber for it.
To define a new service, perform the following steps.
Steps
In the Navigator, choose Setup, then Service Definitions, then Services.
Select the Details tab.
Click the New icon on the task bar. This action causes a blank entry to display in the Services list at the left.
Enter a value for the Display Name. This is the name of the service that is to display in the audit trail and during configuration.
Enter a value for the Internal Name. This is the name for the service that is to be used internally by the system during Service Fulfillment Manager.
Enter a version number.
Check the Provision this Service box.
If you select this box, then you can submit an order against the service.
If you do not select this box, then the configuration of this service is still in progress, and an order can not be submitted against the service.
Enter a short description in the Description field.
Enter the effective date for this service to become active.
Enter the effective date for this service to become inactive.
Enter a value for Responsibility. This sets who is responsible to maintain this information.
Save your changes and close the window.
To complete the definition, you need to associate an action with this service.
An action is an operation performed on a service, product, and package. It instructs the Service Delivery Platform to internally call predefined sets of activities, rules, or data.
For every service that you define, you need to assign an action for Service Fulfillment Manager that desired service. A service combined with an action creates the definition of an order line item.
You can repeat an action across various services, however, this action may not necessarily be valid across all fulfillment elements.
To create a new service action, perform the following steps.
Note: It is possible to associate multiple actions with a single service.
Prerequisites
You must define a service before associating actions with it. (You may also reuse an existing service.) See Defining a New Service for details.
Steps
In the Navigator, choose Setup, then Service Definitions, then Services.
Select the Actions tab.
Select an action from the Available Actions list.
If you do not see the name of the desired action in the Available box, enter the name of the action in the Filter field and click the Find icon to search for it.
If the action is not defined yet, click Define Actions to open the Define Actions window and then add it.
Use the arrow buttons to move your choice from the Available Actions list to the Selected Actions list.
Enter a value for the Start Date. This is the date at which this action becomes available to the service.
Enter a value for the End Date. This is the date at which this action becomes unavailable.
Enter a Description for this action.
Enter a name for the Work Item Mapping Procedure.
If necessary, click the Add/Edit Procedure icon to launch the procedure builder and define a new procedure. See Using the Procedure Builder for details of this process.
Save your changes and close the window.
To associate a work item with a service action, perform the following steps.
Prerequisites
Each service action can have one or more work items defined for it. However, there must be at least one work item for any available service action.
Steps
In the Navigator, choose Setup, then Service Definitions, then Services.
Select a service from the list at the left.
Select the Work Items on Action tab.
Select an action from the drop down list of available actions associated with this service.
If you do not see the action that you want, you need to select the Actions tab and add the action to the list of Selected Actions.
Select a work item from the Available Work Items list.
If you do not see the name of the desired work item in the Available box, enter the name of the work item in the Filter field and click the Find icon to search for it.
If the work item is not defined, click Define Work Items to open the Define Work Items window and then add it. See Defining a New Work Item for details, if necessary.
Use the arrow buttons to move your choice from the Available Work Items list to the Selected Work Items list.
Enter a descriptive comment in the Details of a Selected Work Item field, if desired.
Repeat steps 4 through 8 as many times as necessary.
Save your changes and close the window.
To edit an existing service action, perform the following steps.
Prerequisites
None
Steps
In the Navigator, choose Setup, then Service Definitions, then Services.
Select the Action tab.
Click Define Actions.
Select an existing action from list.
Modify the action parameters.
Save your changes and close the window.
To delete a service, perform the following steps.
Prerequisites
You cannot delete a service if either of the following conditions are true:
If the allowable actions on the service have previously been defined.
If orders have been running for that service.
Steps
In the Navigator, choose Setup, then Service Definitions, then Services.
Select a service from the list at the left.
Click Delete. The service is removed from the list.
Save your changes and close the window.
You perform several different tasks with service packages. These include:
To create a new package of services, perform the following steps.
Prerequisites
None
Steps
In the Navigator, choose Setup, then Service Definitions, then Packages.
Select the Details tab.
Enter a value for the Display name. This is the name of the package that is displayed in the audit trail and during configuration.
Enter a value for the Internal name. The system stores this name in its database to identify the package. (Use underscores rather than blanks in the package name.)
Enter a value for the Description.
Enter a value for the Start Date. This is the date at which this package becomes available.
Enter a value for the End Date. This is the date at which this package becomes unavailable.
Save your changes and close the window.
To associate a service with a package, perform the following steps.
Prerequisites
You must define the service package before you add services to it.
Steps
In the Navigator, choose Setup, then Service Definitions, then Packages.
Select the Services tab.
Select a service from the Available Services list.
If you do not see the name of the desired service in the Available box, enter its name in the Filter field and click the Find icon to search for it.
If the service is not defined yet, click Define Services and then add it. See Defining a New Service for details.
Use the arrow buttons to move your choice from the Available list to the Selected list.
Enter an Activation Sequence value for each service listed under Selected Services.
This value determines the order in which the listed services are activated.
Check Service Fulfillment Manager Required if this service is to be provisioned by the Service Delivery Platform.
If you check this box, then the service is provisioned through the Service Delivery Platform
If you do not check this box, then the service is defined within the Service Delivery Platform Configurator, but is not necessarily activated through the Service Delivery Platform.
This feature enables Service Providers to implement the identical service name among different Service Fulfillment Manager medium without conflict.
Enter a comment in the Comment field, if you want.
Save your changes and close the window.
You perform a number of tasks with work items. These include:
To define a new work item, perform the following steps.
Prerequisites
If you plan to associate a workflow with this work item, then you must create the workflow before you create the work item.
Steps
In the Navigator, choose Setup, then Service Definitions, then Work Items.
Click the New icon on the toolbar. This action causes a blank Details window to display.
Enter the Display name. System screens display this name for the work item.
Enter an Internal name. The system stores this name for the work item in its database.
Enter the Version. The Service Delivery Platform allows multiple versions of a work item.
Enter the Duration. The work item stays active for this length of time.
Enter a Description for this work item.
Enter the Begin Date. The work item becomes available on this date.
Enter the End Date. The work item is no longer available after this date.
Chose a Work Item Type from the list. See Guidelines following for details of work item types.
Chose a user role from the drop down list for Responsibility.
This determines who is responsible to maintain this information (a user, a group, or a user group). It can also be used for fault resolution assignment (i.e., assigning it to the person responsible for ensuring that the problem is resolved).
Save your changes and close the window.
Use the following information in determining the type of work item to choose.
| Work Item Type | Comments |
|---|---|
| Static | If selected, then you must also define the fulfillment actions associated with this work item. See Associating Fulfillment Actions with Work Items for details. |
| Dynamic | If selected, then you must also select a procedure from a list of existing procedures or create a new procedure. The procedure determines the list of fulfillment action’s and their sequence at runtime. |
| User-defined workflow | If selected, enter the Item Type, Process and Key Prefix. You must also enter the name of the workflow that you have created. (Remember that any workflow that you create must be saved to the general Service Delivery Platform engine before it is accessible for use.) |
| User workflow start procedure | If selected, then you must enter the name of the workflow procedure also, or define a new one. |
To delete an existing work item, perform the following steps.
Prerequisites
The data must be visible in your log in role for you to delete it.
Steps
In the Navigator, choose Setup, then Service Definitions, then Work Items.
Select a work item from the list at left.
Click Delete.
The system performs a validation procedure to determine that there are no ill effects to deleting this work item. For example, it checks to see that no parameters or fulfillment actions are assigned to the work item to be deleted. If it passes the validation procedure, then the work item is deleted by the system and it is removed from the list.
To define a new work item, perform the following steps.
Prerequisites
None
Steps
In the Navigator, choose Setup, then Service Definitions, then Work Items.
Select the Parameters tab.
Click Define Parameters. The Define Parameters window opens.
Click the New icon on the toolbar. A blank entry opens in the Display Name list at the left.
Enter a value for the Internal Name of the parameter. The Service Delivery Platform stores this name in its database fro internal use by the system.
Enter a description for the new parameter.
Save your changes and close the window.
To add parameters to a work item, perform the following steps.
Prerequisites
None
Steps
In the Navigator, choose Setup, then Service Definitions, then Work Items.
Select the Parameters tab.
Select a parameter from the Available Parameters list.
If you do not see the name of the desired parameter in the Available box, enter its name in the Filter field and click the Find icon to search for it.
Use the arrow buttons to move your choice from the Available list to the Selected list.
(Optional) Enter a Display Sequence number for each item in the Selected Parameter list.
This value determines the order in which the parameter displays in the work item sequence.
(Optional) Enter a Evaluation Sequence number for each item in the Selected Parameter list.
This value determines the order in which the work item evaluates the parameter.
Check the Required box if this parameter must be present in order to provision the service.
Check the Log in Audit Trail box if this parameter is to be logged and visible in the audit trail.
Parameters that have this box selected (and are actually used with an order), become visible in the audit trail.
Enter a default value, if desired.
This value is displayed in the order, and is changed by the user. For example, this could be an IP address or a password.
Enter a value in the Value Lookup SQL field.
This value is an SQL statement that evaluates the parameter value. If necessary, click Edit Lookup SQL to launch the SQL editor.
Enter a mode for when evaluation of this parameter occurs, if desired. The available choices are:
Upon order receipt
Upon Retrieval
Upon Work Item Start
See the Work Item Mode Guidelines following for considerations on choosing a work item mode.
(Mandatory, if a mode is selected in step 11, otherwise, ignore.) Enter a name for the procedure to be used in evaluating the parameter value.
If necessary, click the Add/Edit procedure icon to launch the procedure builder and define a new procedure. See Using the Procedure Builder for details of this process.
Save your changes and close the window.
You may wish to review the following information before selecting a work item mode.
If you select Upon Order Receipt, then you must also define a name for the procedure and write the body for the evaluation procedure.
The following steps are performed by the Service Fulfillment Manager if a parameter is marked as Upon Order Receipt. The Service Fulfillment Manager:
Receives an order from the upstream system with the parameter and its value.
Performs validation on the parameters.
Executes the evaluation procedure.
Stores the value of the parameter returned from the evaluation procedure. (This value is used in further processing.)
If you select Upon Service Fulfillment Manager Order, then you must also define a name for the procedure and write the body for this procedure.
The following steps are performed by the Service Delivery Platform if a parameter is marked as When Service Fulfillment Manager Order. The Service Delivery Platform:
Receives an order from an upstream system with the parameter and its value.
Performs validation on the parameters.
Stores the value of the parameter as is, without any further manipulation.
At runtime, whenever the parameter is referenced, the associated When Service Fulfillment Manager Order procedure is executed to obtain the new value.
The new value is used for order processing.
To associate a fulfillment action with a work item, perform the following steps.
Prerequisites
You can only associate fulfillment actions with either static or dynamic work items.
Steps
In the Navigator, choose Setup, then Service Definitions, then Work Items.
Select a work item from the list at left.
Select the Fulfillment Actions tab.
The work item type must be static for the Fulfillment Actions tab to be accessible.
Select a fulfillment action from the Available Fulfillment Actions list.
If you do not see the name of the desired fulfillment action in the Available box, enter the name of the fulfillment action in the Filter field and click the Find icon to search for it.
If the user account is not defined yet, click Define Fulfillment Actions to open the Define Fulfillment Actions window and then add it. See Configuring Fulfillment Actions for details on adding a new fulfillment action.
Use the arrow buttons to move your choice from the Available Fulfillment Actions list to the Selected Fulfillment Actions list.
Enter a Service Fulfillment Manager Sequence number for each item in the Selected Fulfillment Actions list.
Enter a Comment for this fulfillment action, if desired.
Save your changes and close the window.
You perform a number of tasks with fulfillment actions. These include:
To define a new fulfillment action, perform the following steps.
Prerequisites
You must perform the following tasks before configuring fulfillment actions:
Configure parameters
Note: User can define the FA Parameters right in the Parameters tab of the FA. User may enter any parameter name and a display value.
Configure fulfillment element types
Configure fulfillment elements
Build the fulfillment procedures
Steps
In the Navigator, choose Setup, then Service Definitions, then Fulfillment Actions. The Fulfillment Actions window opens.
Click the New icon on the toolbar, or chose File > New from the menu. A new, blank entry opens in the Fulfillment Actions list at the left.
Enter a value for the Display name.
This is the name of the fulfillment action that is to display in the audit trail and during configuration.
Enter a value for the Internal name.
This is the name for the fulfillment action that is to be used internally by the system during Service Fulfillment Manager.
Enter the Version number for this fulfillment action.
Enter a value for the fulfillment procedure to select the PL/SQL procedure to execute.
Chose one of the available Fulfillment Element Routing procedures from the drop down list.
If necessary, click the icon next to the Procedure field and create a routing procedure for use here. See Using the Procedure Builder for details.
Enter a value for Evaluate a Parameter.
If necessary, click the icon next to the Procedure field and create an evaluation procedure for use here. See Using the Procedure Builder for details.
Chose a Responsibility from the drop down list, if desired.
If this field is left blank, any user role can use this fulfillment action.
Save your work.
To associate parameters with a fulfillment action, perform the following steps.
Note: A fulfillment action can have more than one parameter associated with it.
Prerequisites
None
Steps
In the Navigator, choose Setup, then Service Definitions, then Fulfillment Actions. The Fulfillment Actions window opens.
Select a fulfillment action from the list at the left.
Select the Parameters tab.
Select a parameter from the Available Parameters list.
If you do not see the name of the desired parameter in the Available box, enter its name in the Filter field and click the Find icon to search for it.
If the parameter is not defined yet, click Define Parameters and then add it. See Defining a New Work Item Parameter for details.
Use the arrow buttons to move your choice from the Available list to the Selected list.
(Optional) Enter a Display Sequence number for each item in the Selected Parameter list.
This value determines the order in which the parameter displays in the fulfillment action sequence.
Enter a Default Value, if desired.
This value is displayed in the order, and is changed by the user. For example, this could be an IP address or a password.
Enter a name for the Evaluation Procedure to be used in evaluating the parameter value. Specify an evaluation procedure for each parameter that you need to define, if desired.
If necessary, click the icon next to the Procedure field to launch the procedure builder and define a new procedure. See Using the Procedure Builder for details of this process.
Save your changes and close the window.
To associate fulfillment procedures with a fulfillment action, perform the following steps.
Prerequisites
A single fulfillment action can have more than one fulfillment procedures defined. However, it must have at least one procedure to indicate the adapter type.
Steps
In the Navigator, choose Setup, then Service Definitions, then Fulfillment Actions.
Select a fulfillment action from the list at left.
Select the Fulfillment Procedures tab.
Chose a Fulfillment Element Type from the drop down list.
If necessary, click Define Types and create a new fulfillment element type.
Enter a value for Software Version (Adapter Type) to set the software version and the connect/disconnect values.
Enter a value for the fulfillment procedure to select the PL/SQL procedure to execute.
If necessary, click the icon next to the Procedure field and create a new procedure for use here.
Save your changes and close the window.
To modify or edit an existing fulfillment procedure, perform the following steps.
Prerequisites
None
Steps
In the Navigator, choose Setup, then Service Definitions, then Fulfillment Actions
Click the icon next to the Procedure field that you wish to modify.
The Add/Edit Procedure window opens.
Modify the procedure as desired.
Save your changes and close the window.
You use the Procedure Builder to perform the following tasks:
To create a new procedure, perform the following steps.
Prerequisites
None
Steps
Open the Add/Edit Procedure window by clicking the icon next to the Procedure field.
Verify the procedure type.
This field is read-only. Its value depends on the form field that called the Add/Edit Procedure window.
Enter the internal name for this procedure.
The Service Delivery Platform uses this name to reference the procedure in its database.
Enter the display name.
This name is displayed in the system screens.
Enter a description of this procedure.
Do one of the following:
Enter the desired PL/SQL code in the Procedure code field.
Click Copy From to copy the code from an existing procedure. Use the Edit function to modify it to meet your needs.
Click OK to compile and generate the procedure.
Use the following guidelines during creation of a procedure.
Do not use an initial DECLARE statement at the beginning of the code block
Use the provided Script Notepad to write your Service Fulfillment Manager procedure.
The following is an example of a connection procedure.
err_code number;
err_str varchar2(400);
BEGIN
LOGIN(‘telnet $ip_address $portnumber’, ‘$username_prompt’, err_code, err_str);
SEND('$username', '$password_prompt', err_code, err_str);
SEND('$password', '$login_prompt', err_code, err_str);
EXCEPTION
WHEN OTHERS THEN
RAISE;
END;Always add the EXCEPTION block at the end of your procedure:
EXCEPTION WHEN OTHERS THEN RAISE END;
You must compile and generate the procedure after finishing the code by clicking OK.
The procedure builder prompts you with compilation errors if you have either of the following conditions exist:
The procedure contains unrecognized parameters.
Note: To display a list of the parameters that can be used in the Service Fulfillment Manager procedure, click Available Parameters.
The displayed parameters are the internal names of the service parameters that you previously configured. Only these internal names can be used inside the Service Fulfillment Manager procedure body
To delete an existing procedure, perform the following steps.
Prerequisites
The procedure to be deleted must not be used by any other objects.
Steps
Open the Add/Edit Procedure window by clicking the icon next to the Procedure field.
Verify that the procedure Type lists the procedure that you wish to delete.
Click the Delete icon on the toolbar.
Click the Save icon on the toolbar to save your changes.
Select File, then Close.
To view the parameters or attributes which can be used in the procedure, perform the following steps.
Prerequisites
None
Steps
Open the Add/Edit Procedure window by clicking the icon next to the Procedure field.
Click Attributes.
Click OK to close the Parameters window.
Click OK to exit the Add/Edit Procedure window.
Note: The parameters or attributes displayed are the internal names of the fulfillment element attributes that you have previously configured. Only internal names can be used inside the procedure body.
To edit an existing procedure, perform the following steps.
Prerequisites
Do not modify a default procedure.
Steps
Open the Add/Edit Procedure window by clicking the icon next to the Procedure field.
Verify the procedure type.
This field is read-only. Its value depends on the form field that called the Add/Edit Procedure window.
Click on the Procedure Code field.
Select Edit, then Edit Field from the menu.
Modify the PL/SQL code in the Procedure Code text field.
Click OK to compile and generate the procedure.
For every fulfillment element that you define, there must first exist a definition of that fulfillment element type.
The following tasks are associated with fulfillment elements types:
Note: Any service order request provisioned through the Service Delivery Platform requires that a specific fulfillment order type for that request also be configured through the Service Delivery Platform.
To define a new fulfillment element type, perform the following steps.
Prerequisites
Fulfillment element types are defined by system experts only.
Steps
In the Navigator, choose Setup, then Interface Definition, then Fulfillment Element Types. The Fulfillment Element Types window opens.
Select the Details tab.
Click Define Types.
Click Add. This action causes a blank Define Fulfillment Element Types window to open.
Complete the fields in the Details tab.
Complete the fields in the Attributes tab.
Complete the fields in the Software tab.
Save your changes and close the window.
To delete an existing fulfillment element type, perform the following steps.
Prerequisites
You can not delete a fulfillment element type if either one of the following conditions is true:
Steps
The attributes for this fulfillment element have previously been defined
The software versions for this fulfillment element previously have been defined
In the Navigator, choose Setup, then Interface Definition, then Fulfillment Element Types. The Fulfillment Element Types window opens.
Select the Details tab.
Select the fulfillment element type to delete from the list at the left.
Click the Delete icon on the toolbar.
Save your changes and close the window.
There are a number of tasks associated with fulfillment elements. These include:
To add a new fulfillment element, perform the following tasks.
Warning: Each Fulfillment Element name must be unique and consist only of alphanumeric characters.
Prerequisites
The type of fulfillment element that you wish to add must exist before you can add the fulfillment element.
Steps
In the Navigator, choose Setup, then Interface Definition, then Fulfillment Elements.
Select the Details tab.
Click the New icon on the toolbar. This action causes a blank Details screen to open.
Complete the fields in the Details tab.
Complete the fields in the SW Versions tab, including both the Details and Attributes sub-tabs.
Save your changes and close the window.
To delete a fulfillment element, perform the following tasks.
Warning: If you delete a fulfillment element, then the logical and physical entity of the fulfillment element is removed from the Service Delivery Platform database.
Prerequisites
You can not delete a fulfillment element, if either the following is true:
Steps
You have previously defined attributes for this fulfillment element.
You have previously defined the software generics for this fulfillment element.
In the Navigator, choose Setup, then Interface Definition, then Fulfillment Elements.
Select the Details tab
Select the fulfillment element that you wish to delete from the list at the left.
Click Delete.
Save your changes and close the window.
If changing a fulfillment element configuration (for example, disabling a fulfillment element, or changing the fulfillment element attributes such as the IP address), perform the following steps.
Prerequisites
None
Steps
Shutdown the Work Item queue to stop the work item dequeuers.
Ensure that there are no fulfillment actions remaining in the Wait for FE queue and the FE Ready queue. This means that all the fulfillment actions are processed at this point.
Shutdown the adapters for the fulfillment element.
Change the attributes for the fulfillment element.
Restart the adapters for the fulfillment element.
Restart the Work Item queue.
Perform the following steps to create either an activity or process timer.
Prerequisites
None
Steps
In the Navigator, choose Setup, then Message Definition, then iMessage Studio.
Click the New icon on the toolbar to create a new timer message.
A blank field opens in the Message Code list.
Enter a name for the new timer in the Message Code field.
The system uses this name for internal identification.
Select the Details tab.
The Elements and Structure tabs are grayed out. Timer messages come with two predefined, mandatory elements: Interval and Duration.
Select Timer from the drop-down list of available types.
Enter a short name for the timer in the Display Name field.
Enter a brief description for the timer.
Select a priority for the timer.
This value sets the priority for the timer message in the Timer Message queue.
Select Timer Queue from the Queue Name drop-down list of values.
(Optional) Choose a responsibility for this message from the drop-down list of values.
Click the Save icon on the toolbar.
You must save your work before proceeding.
Select the Data Source tab.
Select the tree root for the timer.
Select SQL Query from the Data Source Type drop-down list of values.
Select One and Only One from the Data Source Cardinality drop-down list of values.
Specify the source code for the timer in the Source field.
Select the Delay branch from the tree root for the activity timer.
Enter a reference for the Delay branch in the Reference field.
Select the Interval branch from tree root for the Activity Timer
Enter a reference for the Interval branch in the Reference field.
Click the Save icon on the toolbar.
Select the Detail tab.
Click Compile to compile the timer. If an error occurs, verify that you have followed steps 2 - 23 above correctly. After correcting the error, recompile the message.
Click the Close Form icon on the toolbar to close the window.
The source SQL structure for the activity timer must be of the following format:
SELECT ’<D>’ DELAY, ’<I>’ INTERVAL FROM DUAL
Where <D> is delay integer value (in seconds)
<I> is the interval integer value (in seconds)
For example:
SELECT ’0’ DELAY, ’900’ INTERVAL FROM DUAL
The reference value must be of the following format:
xnp$<activity_timer_name>.<select-list column name>
Where <activity_timer_name> is the internal name defined in step 3 above.
<select-list column name> is the first select-list value of the SQL source specified in step 16.
For example:
XNP$ACT_TIMER_1.DELAY
The reference value must be of the following format:
xnp$<activity_timer_name>.<select-list column name>
Where <activity_timer_name>is the internal name defined in step 3 above.
<select-list column name> is the first select-list value of the SQL source specified in step 16.
For example:
XNP$ACT_TIMER_1.INTERVAL
Perform the following steps to create a message timer.
Prerequisites
Before creating the message timer, you must first create the message with which it is associated.
Steps
In the Navigator, choose Setup, then Message Definition, then iMessage Studio.
Click the New icon on the toolbar to create a new timer message.
A blank field opens in the Message Code list.
Enter a name for the new timer in the Message Code field.
The system uses this name for internal identification.
Select the Details tab.
Select Message from the drop-down list of available types.
Enter a short name for the timer in the Display Name field.
Enter a brief description for the timer.
Select a priority for the timer.
This value sets the priority for the timer message in the Timer Message queue.
Select Outbound Message Queue from the Queue Name drop-down list of values.
(Optional) Choose a responsibility for this message from the drop-down list of values.
(Optional) Enter a path reference in the DTD Location field.
Click the Save icon on the toolbar.
You must save your work before proceeding.
Use the Elements tab to add elements to the message.
Use the Structure tab to define the structure of the message.
Save your work before closing the window.
Use the following rules during procedure definition.
Use the provided procedure notepad to write your Service Fulfillment Manager procedure.
Write an anonymous PL/SQL block as to insert into the procedure body.
Use capital letters for all PL/SQL reserved words and the constructs provided by Oracle Provisioning.
Use the standard programming constructs provided by PL/SQL in your block of code, if desired.
Always add the EXCEPTION block at the end of the procedure.
After creating a new procedure, you must compile it. The procedure builder prompts you with compilation errors if you have either of the following conditions exist:
The procedure contains PL/SQL syntax errors.
The procedure contains unrecognized parameters.
The Oracle Application Object Library loader is a general purpose data migration tool that is used for patching seed data, delivering translations, or copying setup or transaction data from development to production systems.
The loader is a concurrent program named FNDLOAD. To use this utility, enter the following command at a UNIX prompt.
FNDLOAD apps/pwd 0 Y mode configfile datafile entity [ param ... ]
The table following lists the parameters used with this executable and describes them.
| Parameter | Description |
|---|---|
| apps/pwd | Specifies the APPS schema and password.
|
| 0 Y | Concurrent program flags |
| mode | Specifies either UPLOAD or DOWNLOAD operation.
|
| configfile | Specifies the configuration file to use.
|
| datafile | Specifies the data file to write.
|
| entity | Specifies the entity type to begin the download or upload.
|
Specifies zero or more additional parameters that are used to provide bind values in the access SQL (for both the UPLOAD and DOWNLOAD operations).
|
You can find the FNDLOAD configuration files for XDP at the following location:
$XDP_TOP/patch/115/import/*.lct
The following table lists the loader files used with Oracle Service Fulfillment Manager and provides the entities and download parameters supported by each.
See the contents of the individual configuration file for full documentation on usage.
| Name | Description | Entity | Optional Download Parameters |
|---|---|---|---|
| xdpparpl.lct | Parameter Pool | XDP_PARAMETER_POOL | PARAMETER_NAME |
| xdpprbod.lct | Procedure Body | XDP_PROC_BODY | PROC_NAME |
| xdpaccod.lct | Action Codes | XDP_ACTION_CODES | ACTION_CODE |
| xdpfacts.lct | Fulfillment Actions | XDP_FULFILL_ACTIONS | FULFILLMENT_ACTION VERSION |
| xdpwipar.lct | Work Items | XDP_WORKITEMS | WORKITEM_NAME VERSION |
| xdpfetyp.lct | Fulfillment Element Types | XDP_FE_TYPES | FULFILLMENT_ELEMENT_TYPE |
| xdpfes.lct | Fulfillment Elements | XDP_FES | FULFILLMENT_ELEMENT_NAME |
| xdpsrves.lct | Services | XDP_SERVICES | SERVICE_NAME VERSION |
| xdppkges.lct | Packages | XDP_SERVICE_PACKAGES | PACKAGE_NAME PACKAGE_VERSION |
The following tables lists dependencies between the various files.
| Name | Dependency |
|---|---|
| apps/pwd | Specifies the APPS schema and password.
|
| 0 Y | Concurrent program flags |
| xdpfacts.lct | First run xdpparpl.lct |
| xdpwipar.lct | First run xdpparpl.lct |
| xdpfes.lct | First run xdpfetyp.lct |
| xdpsrves.lct | First run xdpaccod.lct. |
| xdppkges.lct | First run xdpsrves.lct. |
Several of the loader files also support optional upload parameters. The table following lists them.
| Name | Upload Parameter | Comments |
|---|---|---|
| xdpwipar.lct | OVERRIDE_MAPPNG |
|
| xdpsrves.lct | OVERRIDE_MAPPNG |
|
Applications register with the Event Manager if they need information on specific messages (events) or all instances of that message type. An application can be an external system, an operating system or a mediation layer.
Every message and event is sent to the Event Manager which becomes the source of distribution for events and messages. This is known as event subscription. Event subscription is a business process handled within Workflow.
Applications can be set as default subscribers to specific events and messages. This is configured in the Event Subscriber utility.
Applications can show interest in a specific instance of a message by specifying the REFERENCE_ID of the message.
Applications can register for one of several response messages by using the reference identifier.
When a message with a reference identifier arrives, the Event Manager performs the following tasks:
It executes the validation logic.
It executes the processing logic. It does this before delivering the message to all registered applications.
Applications can show interest in all instances by registering with a NULL reference identifier.
If an application is registered for a specific instance, the registration is automatically unsubscribed after delivering that message.
Upon arrival of an expected response:
The message is delivered to the registered application.
The other expected response is marked EXPIRED.
In the Event Manager, it is possible for default subscribers to subscribe to specific events of the application. When a message occurs, the Event Manager ensures that an outbound message is automatically sent to the subscriber identified by a Fulfillment Element, OSS or gateway.
It is possible to associate one or more responses to an event.
A response is set during the configuration in the form of acknowledgments.
Steps
Create the message or event that is to the trigger for a response.
Configure an Acknowledgment/ Response to the message or event that you created in step 1.
Link the Acknowledgment that you created in step 2 to the message/event that you created in step 2.
If desired, you can associate one or more responses with an event. A response is an acknowledgment to a message.
For example, valid message responses for the message "Is this an existing customer?" are:
"Yes, this is an existing customer."
"No, this is not an existing customer."
These responses are messages in themselves and must be configured in Oracle Service Fulfillment Manager Name before they can be linked as responses to a message.
The Service Fulfillment Manager of various network elements is accomplished with the use of adapters. Adapters are processes which are specialized in certain protocols. (Telnet, FTP, or other protocols.). You direct the adapters to perform various tasks in the system.
Note: To administer the Oracle Service Fulfillment Manager Concurrent Manager, open the Administer Concurrent Managers form the window available through Concurrent > Administer Manager.
Application Start is a concurrent request that is performed by the Oracle Service Fulfillment Manager Concurrent Manager.
You use the Application Start process to perform the following tasks:
Start the entire application, including the Controller, dequeuers and all adapters
Start only the Controller and the dequeuers
Start the Controller, the dequeuers and a subset of the adapters
The system automatically starts all the dequeuers and the Controller during the start process. If any dequeuers are already started, the number actually running is first determined, and matched against the number that are required to be started. The system automatically starts as many dequeuers as needed.
Note: You set the number of running dequeuers through the Queue Console, available through Administration > Queue Console.
Prerequisites
Application Start and Stop are mutually exclusive processes. If one is pending, the opposite operation does not proceed until the first finishes. In addition, the Oracle Service Fulfillment Manager Concurrent Manager processes must be up and running.
Steps
In the a Navigator, select Applications, then Start. The Parameters window appears.
Enter a value in the Options field from the drop-down list of values.
See the Guidelines for information on these choices.
Enter a value in the Fulfillment Element field that is to be included (or excluded) from the application start process.
This choice depends on the value that you chose in step 2, preceding.
Enter a value (0 - 3) for the Debug Mode.
This value sets the level of logging that can be used for debugging purposes.
Click OK.
The Oracle SFM Start dialog box becomes available. Parameters that you set in the previous dialog box display in the Parameters field.
(Optional) Click Copy, if you wish to use start parameters from a prior start request, otherwise proceed to step 7.
If you chose this option, then select from the provided list and continue to step 10.
(Optional) Click Languages..., if you wish to change the default language used in generating the log entries, otherwise proceed to step 8.
If you chose this option, then place a check mark in the box next to the language, or languages, you wish to add. Continue to step 8.
(Optional) Click Schedules..., if you wish to change the default time at which this request is to be run. Perform either 1 or 2, following.
Click Apply a Saved Schedule... to choose from a list of predefined schedules.
Chose an option from the Run the Job... list.You can set how often, and when, you wish the start request to run. Depending on which radio button you check, a number of additional fields display so that you may specify exact dates and times.
(Optional) Click Options..., to specify to whom, and in what language, you wish a notification to be sent. You can also direct the output log files to be sent to a specific printer.
Click Submit to initiate the start process and to close the dialog box.
Note: Each request generates a Request ID. You can use this Request ID to view the request status and the log entries through the View Requests form window, available through Concurrent > View Requests.
Options: The table following lists the available choices. This option indicates which adapters are to be started. You must select from the provided list of values.
| Option | Description |
|---|---|
| ALL | All adapters (for all fulfillment elements) marked AUTOMATIC are started. (You set an adapter to AUTOMATIC through Administration > Connection Manager. You can also use the Adapter Properties form window to configure adapter properties.) |
| INCLUDE | Only adapters marked AUTOMATIC that are associated with the designated fulfillment element are started. |
| EXCLUDE | All adapters marked AUTOMATIC are started, except for those associated with the designated fulfillment element. |
| NONE | No adapters are started. |
Fulfillment Element: Select the fulfillment element that is to be included or excluded (see the preceding table) from the application start. You must select from the provided list of values.
Debug Mode: Select the debugging mode to be used for the Controller and the dequeuer processes. You must select from the provided list of values.
The following table lists the available options.
| Debug Level | Description |
|---|---|
| 0 | No trace |
| 1 | Minimum trace |
| 2 | Medium trace |
| 3 | Maximum trace |
Note: Adapters are started with the debug level configured through the Adapter Properties window.
Application Stop is a concurrent request that is performed by the Oracle Service Fulfillment Manager Concurrent Manager.
You use the Application Stop process to perform the following tasks:
Stop the entire application, including the Controller, dequeuers and all adapters
Stop a subset of the adapters
Prerequisites
Application Start and Stop are mutually exclusive processes. If one is pending, the opposite operation does not proceed until the first finishes. In addition, the Oracle Service Fulfillment Manager Concurrent Manager processes must be up and running.
Steps
In the a Navigator, select Applications, then Stop. The Parameters window appears.
Enter a value in the Options field from the drop-down list of values. See Guidelines for information on these choices.
Enter a value in the Fulfillment Element field that is to be included (or excluded) from the application stop process. This choice depends on the value that you chose in step 2.
Enter a value for the Stop Mode.
Click OK. The Oracle SFM Stop dialog box becomes available. Parameters that you set in the previous dialog box display in the Parameters field.
(Optional) Click Copy, if you wish to use stop parameters copied from a prior stop request, otherwise proceed to step 7.
If you chose this option, then select from the provided list and continue to step 10.
(Optional) Click Languages..., if you wish to change the default language used in generating log entries, otherwise proceed to step 8.
If you chose this option, then place a check mark in the box next to the language, or languages, you wish to add. Continue to step 8.
(Optional) Click Schedules..., if you wish to change the default time at which this request is to be run. Perform either step 1 or 2 given below.
Click Apply a Saved Schedule... to choose from a list of predefined schedules.
Chose an option from the Run the Job... list.You can set how often, and when, you wish the start request to run. Depending on which radio button you check, a number of additional fields display so that you may specify exact dates and times.
(Optional) Click Options..., to specify to whom, and in what language, you wish a notification to be sent. You can also direct the output log files to be sent to a specific printer.
Click Submit to initiate the stop process and to close the dialog box.
Note: Each request generates a Request ID. You can use this Request ID to view the request status and the log entries through the View Requests form window, available through Concurrent > View Requests.
Options: The followingtable lists the available choices. This option indicates which adapters are to be stopped. You must select from the provided list of values.
| Option | Description |
|---|---|
| ALL | All adapters, for all fulfillment elements, dequeuers and the Controller are stopped. This option signifies the complete application stop. |
| INCLUDE | Only adapters marked AUTOMATIC that are associated with the designated fulfillment element are stopped. |
| EXCLUDE | All adapters marked AUTOMATIC are stopped, except for those associated with the designated fulfillment element. |
Fulfillment Element: Select the fulfillment element that is to be included or excluded (see the preceding table) from the application stop. You must select from the provided list of values.
Stop Mode: Select the mode to be used. You must select from the provided list of values.
| Debug Level | Description |
|---|---|
| Normal | This specifies the standard shutdown mode. Depending on the choice that you made under Options, this could be the entire system, or only a subset of it. For example, if you select the NORMAL mode, and the Options value is set to ALL, then the following occurs:
|
| Abort | Specifies an abnormal mode of shutdown. All the running processes (as specified in the Options selection) are terminated at the operating system level. |
Oracle Service Fulfillment Manager comes with a set of predefined constructs that can be used to build procedures. These constructs are.
The SEND macro accepts a command string as an argument. This command string is sent to the fulfillment element as the command to be executed. You use the SEND macro to “send” commands to the network elements.
Signature
The signature of the SEND construct is as follows:
SEND(<command> <varchar2>, <encrypt flag> <varchar2>, <prompt (optional)><varchar2>, <err code (out)> <number>, <error string (out)> <varchar2>)
The application stores all the transactions sent and received, to and from the fulfillment elements in its audit trail. However, it also provides a mechanism that allows you not to store, or write sensitive information contained in the service order request to the audit trail, if desired. Responses from fulfillment elements may also carry the same sensitive information.
Therefore:
If you set the encryption flag to Y, then you are disabling the logging of all responses from the fulfillment elements.
If you set the encryption flag to N, then you are enabling the normal logging of responses from the fulfillment elements.
Syntax
The usage of the construct is defined as follows:
SEND( <command> string which contains the command to be sent,this is where you specify your service parameters in $variable_name format. <‘Y’ or ‘N’> to indicate whether the command response must be logged into the audit trail, <prompt> is an optional field which indicates the prompt at the Network Element after the execution of <command>> <a number place holder for the out parameter error_code>, <a varchar2 place holder for the out parameter error string> );
Restrictions
Note the following restrictions on the use of the SEND macro.
For parameter values with white spaces, specify the corresponding $variable_ names in double quotes.
Eliminate white spaces between SEND and the "(" following it.
Correct Usage: SEND(
Incorrect Usage: SEND (
Do not use SEND inside comments.
The SEND_HTTP macro accepts a command string as an argument. This command is then sent to the fulfillment element as the command to be executed using the HTTP protocol. Typically, in this scenario, the command is an URL.
Signature
The signature of the construct is as follows:
SEND( a string which contains the URL to be sent> , <‘Y’ or ‘N’ indicator which indicates whether the URL should be logged into the audit trail>, <a number place holder for the out parameter error_code>, <a varchar2 place holder for the out parameter error string> );
Restrictions
Note the following restrictions on the use of the SEND_HTTP macro.
Eliminate white spaces between SEND and the "(" following it.
Correct Usage: SEND(
Incorrect Usage: SEND (
The LOGIN macro accepts a command string as an argument. It uses the argument to initiate a connection. Use this macro to initiate a connection to a fulfillment element which has an interactive interface (for example, Telnet).
Note: The LOGIN construct should appear before the first SEND construct in the procedure.
Signature
The signature of the LOGIN construct is as follows:
LOGIN( <a string which contains the command to be sent> , <a string which contains the command response expected>, <a number place holder for the out parameter error_code>, <a varchar2 place holder for the out parameter error string> );
This SEND macro accepts a command string as an argument. It uses the argument to send the command set (connect) to the fulfillment element. One of the connection commands is executed.
Signature
The signature of the LOGIN construct is as follows:
LOGIN( <a string which contains the command to be sent> , <a string which contains the command response expected>, <a number place holder for the out parameter error_code>, <a varchar2 place holder for the out parameter error string> );
Restrictions
Note the following restrictions on the use of the LOGIN macro.
Use the LOGIN macro once only before any SEND construct.
Use the LOGIN macro only in a connect procedure.
Do not use order, line, work item, and fulfillment action as service parameters. The $ variables are fulfillment element attributes, and, as such, can not be used as service parameters.
The RESPONSE_CONTAINS procedure macro is a PL/SQL function that compares a user-defined string against the string returned by a fulfillment element in response to the last command that it received. The macro returns TRUE if the two strings match, otherwise it returns FALSE.
Signature
The signature of the LOGIN construct is as follows:
RESPONSE_CONTAINS( <a string which contains the string to be matched> ) return BOOLEAN;
Restrictions
Note the following restrictions on the use of the RESPONSE_CONTAINS macro.
Do not use $ variables.
Eliminate white spaces between RESPONSE_CONTAINS and the "(" following it.
Incorrect Usage: RESPONSE_CONTAINS (
Correct Usage: RESPONSE_CONTAINS(
The GET_RESPONSE macro returns the response string from the fulfillment elements for the last command sent.
Signature
The signature of the construct is as follows:
GET_RESPONSE return VARCHAR2
Syntax
The usage of the construct is defined as follows:
err_code number; err_str varchar2(400); lv_user varchar2(80); BEGIN lv_user := GET_PARAM_VALUE(‘$WI.user’); SEND(‘AddProfile -h $WI.hostname -p $FA.dbport -u $WI.user’, ‘Y’, err_code, err_str); IF RESPONSE_CONTAINS(‘profile already exist’) THEN NOTIFY_ERROR(‘Error when Service Fulfillment Manager Cisco Secure HA Server. Subscriber ‘ || lv_user || ‘ already exists’,’A’); RETURN; END IF; EXCEPTION WHEN OTHERS THEN RAISE; END;
Restrictions
Note the following restrictions on the use of the GET_RESPONSE macro.
Do not use $ variables.
Eliminate white spaces between RESPONSE_CONTAINS and the "(" following it.
Incorrect Usage: GET_RESPONSE (
Correct Usage: GET_RESPONSE(
Use the GET_PARAM_VALUE procedure macro to obtain the value of the parameter during run-time.
Signature
The signature of the construct is as follows:
GET_PARAM_VALUE (<parameter name> <varchar2>) return VARCHAR2
The <parameter name> is the name of the parameter in $ format.
The value returned by the function can be NULL.
When using this macro, specify the parameters as a $ variable. For example, parameter TN (if used inside a Service Fulfillment Manager procedure), is specified as $ORDER.TN.
Restrictions
Note the following restriction on the use of the GET_PARAM_VALUE macro.
Eliminate white spaces between GET_PARAM_VALUE and the "(" following it.
Incorrect Usage: GET_PARAM_VALUE (
Correct Usage: GET_PARAM_VALUE(
The NOTIFY_ERROR procedure macro indicates an abnormal exit point from the procedure. The Service Fulfillment Manager of a service order request at a fulfillment element has an ERROR status.
This macro appends or replaces a response initiated by the fulfillment element / network element. This is the input string.
Signature
The signature of the construct is as follows:
NOTIFY_ERROR(<user’s string> <varchar2>, <mode> <char>)
The <user's string> contains a user-defined friendly message
The <mode> flag is either A or R.
A indicates that the user message is to be appended to the response string coming from the fulfillment element.
R indicates that the user message is to be replaced by the response string coming from the fulfillment element.
You use this macro under the following conditions:
You want to identify errors coming from the fulfillment element during the Service Fulfillment Manager process.
You want to identify errors when exiting from the Service Fulfillment Manager procedure.
You use the NOTIFY_ERROR macro to abort a Service Fulfillment Manager procedure.
You use the NOTIFY_ERROR macro to abort a Service Fulfillment Manager procedure.
The Service Delivery Platform uses the <user's string> to display the Service Fulfillment Manager errors of a failed Service Order Request. Make this name user-friendly. This name provides the ability to translate cryptic network element error messages into those that are more user friendly.
Following are several example workflow procedures:
Service Fulfillment Manager procedure
Connect procedure
The following is an example of a Service Fulfillment Manager Procedure.
DECLARE err_code number; err_str varchar2(400); lv_user varchar2(80); BEGIN lv_user := GET_PARAM_VALUE (‘$user’); SEND(‘AddProfile -h $hostname -p $dbport -u $user’, ‘Y’, err_code, err_str); IF RESPONSE_CONTAINS (‘profile already exist’) THEN NOTIFY_ERROR(‘Error when Service Fulfillment Manager Cisco Secure HA Server. Subscriber ‘ || lv_user || ‘ already exists’,’A’); RETURN; END IF; EXCEPTION WHEN OTHERS THEN RAISE; END;
The following is an example of a Connect Procedure.
DECLARE err_code number; err_str varchar2(400); lv_user varchar2(80); BEGIN LOGIN(‘telnet $ip_address’, ‘login:’, err_code, err_str); SEND(‘$username’, ‘$Password:’, err_code, err_str); SEND(‘$Password’, ‘$’, err_code, err_str); EXCEPTION WHEN OTHERS THEN RAISE; END;
You can build timer functionality into your user-defined Workflow by using a set of drag-and-drop activities provided by Oracle Service Fulfillment Manager. These activities are part of the SFM Standard item type.
The following table lists the activities that can be associated with timers in Workflow:
| Function Name | Description |
|---|---|
| Deregister | Remove all timers for a given order |
| Fire Timer | Function to start either a process or activity timer |
| Send Message | Function that sends a message which has a timer associated with it |
| Start Related Timers | Function to start either an activity timer or a timer associated with a message |
| Subscribe to Acknowledgements | Function to subscriber for possible results from the Send Message function |
| Get Jeopardy Flag | Checks whether or not a jeopardy timer exists for a given order |
| Get Timer Status | Returns the status of a timer |
| Recalculate all timers | Recalculates the delay and interval elements for all timers associated with the given the Work Item name, Instance ID, Order ID, or the Fulfillment Action Instance ID. |
| Remove Timer | Deletes the timer with the given name |
An Activity Timer is used in conjunction with a workflow activity. The purpose of an Activity Timer is to provide the ability to set a predefined period of time within which a workflow activity must be completed.
For example, a workflow activity is defined to check the network capacity for a requested data service. The time period to perform the workflow activity is set to 30 minutes. An Activity Timer is then associated with the workflow activity to handle the required business logic if the 30 minute time frame for the activity is exceeded.
A Process Timer is used in conjunction with a Workflow process. The purpose of a Process Timer is to provide the ability to set a predefined period of time within which a Workflow process must be completed.
For example, a workflow process is defined to provide a requested data service. The time period to perform the Workflow process is set to one business day. A Process Timer is then associated with the workflow process to handle the required business logic if the one day time frame for the process is exceeded.
A Message Timer is used in conjunction with a message. The purpose of a Message Timer is to provide the ability to set a predefined period of time within which a message acknowledgment must be received.
For example, a workflow process is defined to set up an account for a network service. A message is sent to the associated network service administrator. If a reply is not received back with in 30 minutes, then the timer message is published and picked up by the workflow activity that is Waiting for the Acknowledgments. The acknowledgment may be a message reply or a timer in which the workflow follows a path based on the message received.
The Waiting For Acknowledgments activity subscribes to events. An event can be configured to include an acknowledgment for the message sent out, as well as a timer. Depending on the message received, the workflow progresses.
Workflows are processes that execute during the main Service Fulfillment Manager process to process and fulfill the order. Workflows can be run before starting the Service Fulfillment Manager process.
You use the Oracle Workflow Builder to configure the workflows to be executed during the Service Fulfillment Manager process. The workflow can be invoked for a work item or a fulfillment action.
The main Service Fulfillment Manager workflow waits until all sub-processes complete their activities before continuing to fulfill the order.
If an error occurs during the main Service Fulfillment Manager process, you can intervene manually and launch appropriate workflows as the situation dictates. You can launch any workflow process in Oracle Service Fulfillment Manager, as necessary.
Refer to the Oracle Workflow Guide for details on the workflow builder.
During the execution of a service order, the line items associated with it are processed by workflow. Which fulfillment procedures execute depend on the type and software generic of the fulfillment element configured in Oracle Service Fulfillment Manager.
The mapping between fulfillment procedure and fulfillment element is specified in the Service Creation Manager.
The fulfillment procedure involves sending commands to a fulfillment element, receiving, and analyzing responses to determine success or failure of commands.
The procedures are written in PL/SQL which has been extended with open APIs.
A watchdog workflow detects the termination of adapter processes and manages their recovery.
When all adapters for a given fulfillment element are shutdown, suspended, disconnected or goes down, all service order requests for that fulfillment element are queued until the adapter is up again and ready to process the next fulfillment action in the queue.
A service order consists of many line items. A line item can be either a service or a package.
Each line item can be mapped to multiple work items.
Each work item is mapped to a set of fulfillment actions via different means. (For example, this could be either a static or dynamic fulfillment action, workflow, or a workflow procedure.)
Each fulfillment action invokes one fulfillment procedure at runtime depending on the type of fulfillment element.
Each procedure is executed on one fulfillment element.
The identity of the fulfillment element to be provisioned is determined through routing rules implemented through user-defined PL/SQL procedure.
Error conditions detected during Service Fulfillment Manager cause the workflow to send error notifications.
The workflow waits for the notification response.
The response indicates how the error condition is to be handled.
The Workflow Monitor utility provides a graphical interface to track a service order’s path in Oracle Service Fulfillment Manager. When launched, it opens in a web browser screen.
Using the graphical interface, you can:
View each activity performed on an order.
View the route of an order from the beginning to the end.
Retrieve statistical information and branching activities for each node displayed on the workflow path.