Oracle® Fusion Applications Developer's Guide 11g Release 7 (11.1.7) Part Number E15524-08 |
|
|
PDF · Mobi · ePub |
This appendix provides a reference for the commands available for the Oracle Enterprise Crawl and Search (ECSF) Command Line Administration Utility. You can use the ECSF Command Line Administration Utility to quickly test and manage the searchable objects without having to use Oracle Enterprise Manager Fusion Applications Control for ECSF.
Note:
Administrators should use Fusion Applications Control for ECSF to manage the life cycle of searchable objects in the production environment.
Table B-1 shows the commands you can use to administer search. The commands appear in alphabetical order.
Table B-1 ECSF Command Line Administration Utility Commands
Command | Description |
---|---|
|
Activates a searchable object so that a query of it returns results. Specify the ID number corresponding to the searchable object you want to activate. Only a searchable object that has been deployed can be activated. Customized searchable objects cannot be activated using the ECSF Command Line Administration Utility. You must activate customized searchable objects by using the Fusion Applications Control for ECSF. |
|
Associates the searchable object you specify with the search category you specify. Specify the ID number corresponding to the searchable object you want to add to the search category, and specify the ID number corresponding to the search category to which you want to add the searchable object. Searchable objects must be deployed before you can associate them with search categories. Search categories must be undeployed before you can associate searchable objects with them. You can associate the same searchable object with multiple search categories. You must issue the command while managing the search engine instance with which the search category is associated. |
|
Associates a searchable object with the search category you specify. Specify the ID number corresponding to the search category to which you want to add the searchable object. The ECSF Command Line Administration Utility displays a list of available searchable objects and prompts you to enter the ID corresponding to the searchable object you want to associate with the search category. Searchable objects must be deployed before you can associate them with search categories. Search categories must be undeployed before you can associate searchable objects with them. You can associate the same searchable object with multiple search categories. You must issue the command while managing the search engine instance with which the search category is associated. |
|
Associates the searchable object you specify with the index schedule you specify. Specify the ID number corresponding to the searchable object you want to add to the index schedule, and specify the ID number corresponding to the index schedule to which you want to add the searchable object. Searchable objects must be deployed before you can associate them with index schedules. You can only associate each searchable object with one index schedule. Only a searchable object that is not already associated with an index schedule can be added to an index schedule. Index schedules must be undeployed before you can associate searchable objects with them. You must issue the command while managing the search engine instance with which the index schedule is associated. |
|
Associates the searchable object you specify with the index schedule you specify. Specify the ID number corresponding to the index schedule to which you want to add the searchable object. The ECSF Command Line Administration Utility displays a list of available searchable objects and prompts you to enter the ID corresponding to the searchable object you want to associate with the index schedule. Searchable objects must be deployed before you can associate them with index schedules. You can only associate each searchable object with one index schedule. Only a searchable object that is not already associated with an index schedule can be added to an index schedule. Index schedules must be undeployed before you can associate searchable objects with them. You must issue the command while managing the search engine instance with which the index schedule is associated. |
|
Associates a searchable object with the specified search engine instance. The ECSF Command Line Administration Utility displays a list of available searchable objects and prompts you to enter the ID corresponding to the searchable object you want to add to the search engine instance. You must issue the command while managing the search engine instance to which you want to add the searchable object. A searchable object can only be associated with one search engine instance at a time. |
|
Associates a searchable object with the specified search engine instance. Specify the ID corresponding to the searchable object you want to add to the search engine instance. You must issue the command while managing the search engine instance to which you want to add the searchable object. A searchable object can only be associated with one search engine instance at a time. |
|
Creates the connection to a database using a system identifier (SID). Follow the prompts to enter a username and password, as well as field values. |
|
Creates the connection to a database using a system identifier (SID). Specify the host name, port number, and SID. Follow the prompts to enter a username and password. |
|
Creates the connection to a database using a database descriptor. Follow the prompts to enter a username and password, as well as field values. |
|
Creates the connection to a database using a database descriptor. Specify the descriptor, enclosing it in quotes, with either the system identifier (SID) or service name, for example: Using SID:
Using service name:
Follow the prompts to enter a username and password. |
|
Creates the connection to a database using a service name. Follow the prompts to enter a username and password, as well as field values. |
|
Creates the connection to a database using a service name. Specify the host name, port number, and service name. Follow the prompts to enter a username and password. |
|
Creates the connection to an MBean server. Follow the prompts to enter a username and password, as well as field values. |
|
Creates the connection to an MBean server. Specify the host name and port number. Follow the prompts to enter a username and password. |
|
Adds a new search category to the If you issue the command while managing a search engine instance, the search category is automatically associated with the search engine instance you are managing. If you issue the command outside a search engine instance context, the ECSF Command Line Administration Utility displays a list of the available search engine instances and prompts you to choose a search engine instance for the search category you want to create. |
|
Adds a new search category to the The field names and values must be enclosed in quotes. If the field name or value contains a quote, escape it with a backslash, for example, If you issue the command while managing a search engine instance, the search category is automatically associated with the search engine instance you are managing. If you issue the command outside of a search engine instance context, the ECSF Command Line Administration Utility displays a list of the available search engine instances and prompts you to choose a search engine instance for the search category you want to create. |
|
Adds a new search engine instance to the specified search engine type. Follow the prompts to enter field values. You must issue the command while not managing a search engine instance. |
|
Adds a new search engine instance to the specified search engine type. Directly pass in field name-value pairs with the command. The field names and values must be enclosed in quotes. If the field name or value contains a quote, escape it with a backslash, for example, You must issue the command while not managing a search engine instance. |
|
Adds a new searchable object to the specified search engine type. Follow the prompts to enter field values. If you issue the command while managing a search engine instance, the searchable object is automatically associated with the search engine instance you are managing. If you issue the command outside a search engine instance context, the ECSF Command Line Administration Utility displays a list of the available search engine instances and prompts you to choose a search engine instance for the searchable object you want to create. |
|
Adds a new index schedule to the If you issue the command while managing a search engine instance, the index schedule is automatically associated with the search engine instance you are managing. If you issue the command outside a search engine instance context, the ECSF Command Line Administration Utility displays a list of the available search engine instances and prompts you to choose a search engine instance for the index schedule you want to create. |
|
Adds a new index schedule to the The field names and values must be enclosed in quotes. If the field name or value contains a quote, escape it with a backslash, for example, If you issue the command while managing a search engine instance, the index schedule is automatically associated with the search engine instance you are managing. If you issue the command outside a search engine instance context, the ECSF Command Line Administration Utility displays a list of the available search engine instances and prompts you to choose a search engine instance for the index schedule you want to create. |
|
Adds a new searchable object to the specified search engine type. Follow the prompts to enter field values. The searchable object is not associated with a search engine instance. |
|
Deactivates a searchable object so that a query of it does not return results. Specify the ID number corresponding to the searchable object you want to deactivate. Only an activated searchable object can be deactivated. Deactivated searchable objects are still available for the search engine instance to crawl. |
|
Disassociates the specified search category from the search engine instance and removes it from the You must issue the command while managing the search engine instance with which the search category is associated. |
|
Removes the specified external search category from the |
|
Removes the specified search engine instance. You cannot delete search engine instances while you are managing an engine instance. You cannot delete a search engine instance if there are any deployed objects, categories, or schedules associated with it. |
|
Removes the specified assigned searchable object (associated with a search engine instance) from the ECSF schema in the Oracle Fusion Applications database. You must issue the command while managing the search engine instance with which the searchable object is associated. If the searchable object has been deployed, you must undeploy it before you can delete its record from the database. |
|
Disassociates the specified index schedule from the search engine instance and removes it from the You must issue the command while managing the search engine instance with which the index schedule is associated. |
|
Removes the specified unassigned searchable object (not associated with a search engine instance) from the ECSF schema in the Oracle Fusion Applications database. |
|
Deploys the specified search category to the search engine instance. Specify the ID number corresponding to the search category you want to deploy. Searchable objects must be associated with the search category before you can deploy it. You must issue the command while managing the search engine instance with which the search category is associated. |
|
Deploy the searchable object you specify to the search engine instance to make the objects available for the search engine instance to crawl. Specify the ID number corresponding to the searchable object you want to deploy. The searchable objects deployed to the search engine instance must have a unique and fully qualified name, for example, |
|
Collectively updates all deployed searchable objects with the latest search engine instance parameters. |
|
Updates the specified searchable object with the latest search engine instance parameters. |
|
Deploys the specified index schedule to the search engine instance. Specify the ID number corresponding to the index schedule you want to deploy. Searchable objects must be associated with the index schedule before you can deploy it. You must issue the command while managing the search engine instance with which the index schedule is associated. |
|
Disconnects you from the current database or MBean server connection. |
|
Closes the ECSF Command Line Administration Utility. |
|
Lists all the available |
|
Lists the valid syntax for the |
|
Lists the valid syntax for the |
|
Lists the commands that can be used for search categories. |
|
Lists the valid syntax for the |
|
Lists the fields available for the |
|
Lists the fields available for the |
|
Lists the fields available for the |
|
Lists the fields available for the |
|
Lists the fields available for the |
|
Lists the fields available for the |
|
Lists the valid syntax for the |
|
Lists the valid syntax for the |
|
Lists the valid syntax for the |
|
Lists the valid syntax for the |
|
Lists the commands that can be used for search engine instances. |
|
Lists the valid syntax for the |
|
Lists the valid syntax for the |
|
Lists the commands that can be used for searchable objects. |
|
Lists the commands that can be used for search engine instance parameters. |
|
Lists the valid syntax for the |
|
Lists the commands that can be used for index schedules. |
|
Lists the valid syntax for the set commands. |
|
Lists the valid syntax for the |
|
Lists the valid syntax for the |
help stop |
Lists the valid syntax for the |
|
Lists the commands that can be used for unassigned searchable objects. |
|
Lists the valid syntax for the |
|
Lists the valid syntax for the |
|
Lists the fields available for the |
|
Lists the fields available for the |
|
Lists the fields available for the |
|
Lists the fields available for the |
|
Lists one by one all the external categories of the search engine instance you are managing and prompts you to confirm whether you want to import each external category. Enter All external search categories that have been previously imported will be replaced by the latest import from Oracle Secure Enterprise Search (Oracle SES). If you had previously deleted any of the records corresponding to the external search categories, you must delete them again to make them unavailable for querying. |
|
Lists one by one all the external categories of the search engine instance you specify and prompts you to confirm whether you want to import each external category. Enter All external search categories that have been previously imported will be replaced by the latest import from Oracle Secure Enterprise Search (Oracle SES). If you had previously deleted any of the records corresponding to the external search categories, you must delete them again to make them unavailable for querying. |
|
Lists the search categories and their corresponding ID numbers for the search engine instance you are managing. |
|
Lists the search categories and their corresponding ID numbers for the search engine instance you specify. Specify the ID number corresponding to the desired search engine instance. |
|
Lists the external search categories and their corresponding ID numbers for the search engine instance you are managing. |
|
Lists the external search categories and their corresponding ID numbers for the search engine instance you specify. Specify the ID number corresponding to the desired search engine instance. |
|
Lists the search engine instances and their corresponding ID numbers |
|
Lists a summary of the searchable objects associated with the search engine instance you are managing. |
|
Lists a summary of the searchable objects associated with the search category you specify. Specify the ID number corresponding to the desired search category. |
|
Lists a summary of the searchable objects associated with the search engine instance you specify. Specify the ID number corresponding to the desired search engine instance. |
|
Lists a summary of the searchable objects associated with the index schedule you specify. Specify the ID number corresponding to the desired index schedule. |
|
Lists the parameters that are available for the |
|
Lists the parameters that are available for the |
|
Lists the index schedules associated with the search engine instance you are managing. |
|
Lists the index schedules associated with the search engine instance you specify. Specify the ID number corresponding to the desired search engine instance. |
|
Lists the unassigned searchable objects (not associated with a search engine instance) and their corresponding ID numbers. |
|
Sets the context to the specified search engine instance. The ECSF Command Line Administration Utility lists all the search engine instances and their corresponding ID numbers and prompt you for the ID number of the search engine instance you want to manage. |
|
Sets the context to the search engine instance you specify. Specify the ID number corresponding to the search engine instance you want to manage. |
|
Registers an identity plug-in for the instance you are managing. The deployment of the Federated Trust Entity occurs when the identity plug-in is registered. |
|
Registers an identity plug-in for the search engine instance you specify. Specify the ID number corresponding to the desired search engine instance. The deployment of the Federated Trust Entity occurs when the identity plug-in is registered. |
|
Associates the specified searchable object with the search engine instance you are managing and creates a new record for the searchable object in the ECSF schema of the Oracle Fusion Applications database. Follow the prompts to enter field values. For BO Name, you must enter a fully qualified view object name defined in your application. |
|
Associates the specified searchable object with the search engine instance you are managing and creates a new record for the searchable object in the Oracle Fusion Applications database. Directly pass in field name-value pairs with the command. The field names and values must be enclosed in quotes. If the field name or value contains a quote, escape it with a backslash, for example, |
|
Creates a new record of an unassigned searchable object (not associated with a search engine instance) in the Oracle Fusion Applications database. Follow the prompts to enter field values. For BO Name, you must enter a fully qualified view object name defined in your application. |
|
Creates a new record of an unassigned searchable object (not associated with a search engine instance) in the Oracle Fusion Applications database. Directly pass in field name-value pairs with the command. The field names and values must be enclosed in quotes. If the field name or value contains a quote, escape it with a backslash, for example, |
|
Disassociates a searchable object from the search category you specify. Specify the ID number corresponding to the search category from which you want to disassociate the searchable object. The ECSF Command Line Administration Utility displays a list of searchable objects and prompts you to enter the ID corresponding to the searchable object you want to remove from the search category. You must issue the command while managing the search engine instance with which the search category is associated. The searchable object is still available for association to other search categories. |
|
Disassociates the specified searchable object from the search category you specify. Specify the ID number corresponding to the searchable object you want to remove from the search category. Specify the ID number corresponding to the search category from which you want to disassociate the searchable object. You must issue the command while managing the search engine instance with which the search category is associated. The searchable object is still available for association to other search categories. |
|
Disassociates a searchable object from the specified search engine instance and makes it available for association to another search engine instance. The ECSF Command Line Administration Utility displays a list of searchable objects and prompts you to enter the ID corresponding to the searchable object you want to remove from the search engine instance. To disassociate a searchable object from a search engine instance, both the object and the instance must be undeployed. |
|
Disassociates a searchable object from the specified search engine instance and makes it available for association to another search engine instance. Specify the ID number corresponding to the search engine instance from which you want to remove the searchable object. The ECSF Command Line Administration Utility displays a list of searchable objects and prompts you to enter the ID corresponding to the searchable object you want to remove from the search engine instance. To disassociate a searchable object from a search engine instance, both the object and the instance must be undeployed. |
|
Disassociates the specified searchable object from the search engine instance and makes it available for association to another search engine instance. Specify the ID number corresponding to the searchable object you want to remove. To disassociate a searchable object from a search engine instance, both the object and the instance must be undeployed. |
|
Disassociates the searchable object from the search engine instance and makes it available for association to another search engine instance. Specify the ID number corresponding to the searchable object you want to remove and the ID number corresponding to the search engine instance from which you want to remove the searchable object. To disassociate a searchable object from a search engine instance, both the object and the instance must be undeployed. |
|
Disassociates a searchable object from the specified index schedule and makes it available to be added to another index schedule. Specify the ID number corresponding to the index schedule from which you want to disassociate the searchable object. The ECSF Command Line Administration Utility displays a list of searchable objects and prompts you to enter the ID corresponding to the searchable object you want to remove from the index schedule. To disassociate a searchable object from an index schedule, the index schedule must not be deployed. You must issue the command while managing the search engine instance with which the index schedule is associated. |
|
Disassociates the searchable object you specify from the specified index schedule and makes it available to be added to another index schedule. Specify the ID number corresponding to the searchable object you want to disassociate and the ID number corresponding to the index schedule from which you want to disassociate the searchable object. To disassociate a searchable object from an index schedule, the index schedule must not be deployed. You must issue the command while managing the search engine instance with which the index schedule is associated. |
|
Sets parameter values for the search engine instance. Use the following command syntax to directly pass in one parameter name-value pair at a time: See the "Managing Search with Oracle Enterprise Crawl and Search Framework" chapter in the Oracle Fusion Applications Administrator's Guide for a list of known engine instance parameters. The parameter name and value must be enclosed in quotes. If the parameter name or value contains a quote, escape it with a backslash, for example, You must issue the command while managing the search engine instance whose password parameters you want to set. |
|
Sets password parameter values for the search engine instance. Pass in one password parameter and its password. See the "Managing Search with Oracle Enterprise Crawl and Search Framework" chapter in the Oracle Fusion Applications Administrator's Guide for a list of known engine instance parameters. The password parameter name must be enclosed in quotes. If the parameter parameter name contains a quote, escape it with a backslash, for example, You must issue the command while managing the search engine instance whose password parameters you want to set. |
|
Lists detailed information about the specified search category and the searchable objects associated with it. |
|
Lists the detailed information about the specified unassigned searchable object. |
|
Lists the detailed information for the search engine instance being managed. You must issue the command while managing a search engine instance. |
|
Lists the detailed information about the specified search engine instance. |
|
Lists the detailed information about the specified searchable object. |
|
Lists the detailed information about the specified search engine instance parameter. |
|
Lists detailed information about the specified index schedule and the searchable objects associated with it. |
|
Launches the index schedule you specify and causes Oracle SES to create the full-text search indexes. Specify the ID corresponding to the index schedule you want to start. Index schedules must be deployed to the search engine instance before you can start it. You must issue the command while managing the search engine instance with which the index schedule is associated. |
|
Stops the specified index schedule that has been started and aborts the index process. Specify the ID number of the index schedule you want to stop. You must issue the command while managing the search engine instance with which the index schedule is associated. |
|
Removes a search category from the search engine instance. Specify the ID number corresponding to the search category you want to undeploy. You must issue the command while managing the search engine instance with which the search category is associated. |
|
Removes a searchable object from the search engine instance to make the object unavailable for the search engine instance to crawl. Specify the ID number corresponding to the searchable object you want to undeploy. Only deployed and deactivated searchable objects can be undeployed. |
|
Removes the specified index schedule from the search engine instance. Specify the ID number corresponding to the index schedule you want to undeploy. You must issue the command while managing the search engine instance with which the index schedule is associated. |
|
Resets or exits the search engine instance context. |
|
Resets or exits the search engine instance context. |
|
Modifies the properties of the specified search category. Specify the ID number corresponding to the search category you want to modify. Follow the prompts to enter field values. Set the scope of the search category to You must issue the command while managing the search engine instance with which the search category is associated. |
|
Modifies the properties of the specified search category. Use the following command syntax to directly pass in field name-value pairs with the command: The field names and values must be enclosed in quotes. If the field name or value contains a quote, escape it with a backslash, for example, Set the scope of the search category to You must issue the command while managing the search engine instance with which the search category is associated. |
|
Modifies the application identity of the specified external search category. Specify the ID number corresponding to the external search category you want to modify. Follow the prompts to enter field values. Set the scope of the search category to You must issue the command while managing the search engine instance with which the external search category is associated. |
|
Modifies the application identity of the specified external search category. Use the following command syntax to directly pass in a field name-value pair with the command: The field name and value must be enclosed in quotes. If the field name or value contains a quote, escape it with a backslash, for example, Set the scope of the search category to You must issue the command while managing the search engine instance with which the external search category is associated. |
|
Modifies the properties of the search engine instance you are currently managing. If you are not currently managing a search engine instance, the ECSF Command Line Administration Utility lists all the search engine instances and their corresponding ID numbers and prompt you for the ID number of the search engine instance you want to modify. Follow the prompts to enter field values. |
|
Modifies the properties of the search engine instance you specify. Specify the ID number corresponding to the search engine instance you want to modify. Follow the prompts to enter field values. |
|
Modifies the properties of the search engine instance you are currently managing. Directly pass in field name-value pairs with the command. The field names and values must be enclosed in quotes. If the field name or value contains a quote, escape it with a backslash, for example, |
|
Modifies the properties of the search engine instance you specify. Specify the ID number corresponding to the search engine instance you want to modify and directly pass in field name-value pairs with the command. The field names and values must be enclosed in quotes. If the field name or value contains a quote, escape it with a backslash, for example, |
|
Modifies the display name and application ID of a deployed searchable object without first having to deactivate and undeploy the searchable object. Specify the ID number of the searchable object you want to modify. Follow the prompts to enter field values for the display name and application ID. You must issue the command while managing the search engine instance with which the searchable object is associated. |
|
Modifies the display name and application ID of a deployed searchable object without first having to deactivate and undeploy the searchable object. Specify the ID number corresponding to the searchable object you want to modify and directly pass in field name-value pairs with the command. The field names and values must be enclosed in quotes. If the field name or value contains a quote, escape it with a backslash, for example, You must issue the command while managing the search engine instance with which the searchable object is associated. |
|
Modifies the properties of the index schedule you specify. Specify the ID number corresponding to the index schedule you want to modify. Follow the prompts to enter new field values. |
|
Modifies the properties of the index schedule you specify. Specify the ID number corresponding to the index schedule you want to modify and directly pass in field name-value pairs with the command. The field names and values must be enclosed in quotes. If the field name or value contains a quote, escape it with a backslash, for example, You must issue the command while managing the search engine instance with which the index schedule is associated. |