|
Package admin_api |
| Program units |
| Get_User_Preference_Value | Returns the value of the given preference for the given user |
| Set_User_Preference_Value | Updates the value of the given preference for the given user |
| Get_Preference_Default_Value | Returns the default value of the given preference |
| Set_Preference_Default_Value | Updates the default value of the given preference |
| Get_Config_Parameter_Value | Returns the value of the given configuration parameter |
| Set_Config_Parameter_Value | Updates the value of the given configuration parameter |
| Create_Document_Group | Creates a new document group |
| Delete_Document_Group | Deletes the specified document group |
| Update_Document_Group | Updates the specified document group |
| Create_Initial_Path | Creates a new initial path |
| Update_Initial_Path | Updates the specified initial path |
| Delete_Initial_Path | Deletes the specified initial path |
| Restart_Job | Restarts the indexing of the specified document group |
| Resume_Job | Resumes the indexing of the specified document group |
| Stop_Job | Stops the indexing of the specified document group |
| Create_Schedule | Creates a new schedule |
| Update_Schedule | Updates the specified schedule |
| Delete_Schedule | Deletes the schedule and schedule processes with the specified schedule id and the schedule and schedule processes with the specified cusom id |
| Delete_Expired_Schedules | Deletes all expired schedules, or if a document group is specified deletes its expired schedules |
| Exceptions |
| user_not_authorized | Occurs when the user is not properly authorized |
| user_not_admin | Occurs when the user is not an administrator and they need to be |
| user_not_document_admin | Occurs when the user is not a document group administrator |
| user_not_app_admin | Occurs when the user is not an application administrator |
| preference_value_not_valid | Occurs when the preference value is not valid according to the type, min/max, etc. |
| config_value_not_valid | Occurs when the config value is not valid according to the type, min/max, etc. |
| missing_item_name | Occurs when the document group name's length is 0 |
| null_item_name | Occurs when the document group name is NULL |
| duplicate_item_name | Occurs when the document group name already exists |
| document_group_not_specified | Occurs when the document group id is not specified |
| location_not_specified | Occurs when the location is not specified |
| search_depth_not_specified | Occurs when the search depth is not specified |
| initial_path_already_exists | Occurs when the same location already exists as an initial path in the same document group |
| invalid_start_time | Occurs when the start time of a schedule is not valid |
| start_time_expired | Occurs when the start time of a schedule has expired |
| invalid_stop_time | Occurs when the stop time of a schedule is not valid |
| invalid_time_frame | Occurs when the time frame of a schedule is not valid |
| Variables |
| GC_INDEXING_STATUS_NOT_INDEXED | The id of the indexing status with name 'NOT INDEXED' |
| GC_INDEXING_STATUS_INDEXED | The id of the indexing status with name 'INDEXED' |
| GC_INDEXING_STATUS_SKIPPED | The id of the indexing status with name 'SKIPPED' |
| GC_INDEXING_STATUS_FAILED | The id of the indexing status with name 'FAILED' |
| GC_CRAWLING_STATUS_MODIFIED | The id of the crawling status with name 'MODIFIED' |
| Constants |
| GC_INDEX_TABLE_PREFIX | The prefix of the index table name |
| GC_CTX_IX_POSTFIX | The suffix of the ctxsys.CONTEXT index |
| GC_US_CRAWLER_TABLE_PREFIX | The prefix of the UC crawler table name |
| GC_FILE_CRAWLER_TABLE_PREFIX | The prefix of the file crawler table name |
| GC_ZIP_CRAWLER_TABLE_PREFIX | The prefix of the zip crawler table name |
| GC_MAIL_CRAWLER_TABLE_PREFIX | The prefix of the mail crawler table name |
| GC_LDAP_CRAWLER_TABLE_PREFIX | The prefix of the LDAP crawler table name |
| GC_SIS_CRAWLER_TABLE_PREFIX | The prefix of the SIS crawler table name |
GC_INDEXING_STATUS_NOT_INDEXED
GC_INDEXING_STATUS_NOT_INDEXED NUMBER;
The id of the indexing status with name 'NOT INDEXED'
GC_INDEXING_STATUS_INDEXED
GC_INDEXING_STATUS_INDEXED NUMBER;
The id of the indexing status with name 'INDEXED'
GC_INDEXING_STATUS_SKIPPED
GC_INDEXING_STATUS_SKIPPED NUMBER;
The id of the indexing status with name 'SKIPPED'
GC_INDEXING_STATUS_FAILED
GC_INDEXING_STATUS_FAILED NUMBER;
The id of the indexing status with name 'FAILED'
GC_CRAWLING_STATUS_MODIFIED
GC_CRAWLING_STATUS_MODIFIED NUMBER;
The id of the crawling status with name 'MODIFIED'
GC_INDEX_TABLE_PREFIX
GC_INDEX_TABLE_PREFIX CONSTANT VARCHAR2(20) := 'TS_TBL_';
The prefix of the index table name
GC_CTX_IX_POSTFIX
GC_CTX_IX_POSTFIX CONSTANT VARCHAR2(20) := '_CIX';
The suffix of the ctxsys.CONTEXT index
GC_US_CRAWLER_TABLE_PREFIX
GC_US_CRAWLER_TABLE_PREFIX CONSTANT VARCHAR2(20) := 'TS_TBL_UC_';
The prefix of the UC crawler table name
GC_FILE_CRAWLER_TABLE_PREFIX
GC_FILE_CRAWLER_TABLE_PREFIX CONSTANT VARCHAR2(20) := 'TS_TBL_FC_';
The prefix of the file crawler table name
GC_ZIP_CRAWLER_TABLE_PREFIX
GC_ZIP_CRAWLER_TABLE_PREFIX CONSTANT VARCHAR2(20) := 'TS_TBL_ZC_';
The prefix of the zip crawler table name
GC_MAIL_CRAWLER_TABLE_PREFIX
GC_MAIL_CRAWLER_TABLE_PREFIX CONSTANT VARCHAR2(20) := 'TS_TBL_MC_';
The prefix of the mail crawler table name
GC_LDAP_CRAWLER_TABLE_PREFIX
GC_LDAP_CRAWLER_TABLE_PREFIX CONSTANT VARCHAR2(20) := 'TS_TBL_LC_';
The prefix of the LDAP crawler table name
GC_SIS_CRAWLER_TABLE_PREFIX
GC_SIS_CRAWLER_TABLE_PREFIX CONSTANT VARCHAR2(20) := 'TS_TBL_SIS_';
The prefix of the SIS crawler table name
user_not_authorized
user_not_authorized EXCEPTION;
Occurs when the user is not properly authorized
user_not_admin
user_not_admin EXCEPTION;
Occurs when the user is not an administrator and they need to be
user_not_document_admin
user_not_document_admin EXCEPTION;
Occurs when the user is not a document group administrator
user_not_app_admin
user_not_app_admin EXCEPTION;
Occurs when the user is not an application administrator
preference_value_not_valid
preference_value_not_valid EXCEPTION;
Occurs when the preference value is not valid according to the type, min/max, etc.
config_value_not_valid
config_value_not_valid EXCEPTION;
Occurs when the config value is not valid according to the type, min/max, etc.
missing_item_name
missing_item_name EXCEPTION;
Occurs when the document group name's length is 0
null_item_name
null_item_name EXCEPTION;
Occurs when the document group name is NULL
duplicate_item_name
duplicate_item_name EXCEPTION;
Occurs when the document group name already exists
document_group_not_specified
document_group_not_specified EXCEPTION;
Occurs when the document group id is not specified
location_not_specified
location_not_specified EXCEPTION;
Occurs when the location is not specified
search_depth_not_specified
search_depth_not_specified EXCEPTION;
Occurs when the search depth is not specified
initial_path_already_exists
initial_path_already_exists EXCEPTION;
Occurs when the same location already exists as an initial path in the same document group
invalid_start_time
invalid_start_time EXCEPTION;
Occurs when the start time of a schedule is not valid
start_time_expired
start_time_expired EXCEPTION;
Occurs when the start time of a schedule has expired
invalid_stop_time
invalid_stop_time EXCEPTION;
Occurs when the stop time of a schedule is not valid
invalid_time_frame
invalid_time_frame EXCEPTION;
Occurs when the time frame of a schedule is not valid
Get_User_Preference_Value
Function Get_User_Preference_Value(p_username IN VARCHAR2,
p_password IN VARCHAR2,
p_preference_id IN NUMBER)
RETURN VARCHAR2
Returns the value of the given preference for the given user
| Parameters |
| p_username |
The name of the directinfo user that is used for authorisation | |
| p_password |
The password of the directinfo user that is used for authorisation | |
| p_preference_id |
The id of the user preference which value the function gets |
Set_User_Preference_Value
Procedure Set_User_Preference_Value(p_username IN VARCHAR2,
p_password IN VARCHAR2,
p_preference_id IN NUMBER,
p_value IN VARCHAR2)
Updates the value of the given preference for the given user
| Parameters |
| p_username |
The name of the directinfo user that is used for authorisation | |
| p_password |
The password of the directinfo user that is used for authorisation | |
| p_preference_id |
The id of the user preference which value the function sets | |
| p_value |
The value to be set to the user preference |
Get_Preference_Default_Value
Function Get_Preference_Default_Value(p_username IN VARCHAR2,
p_password IN VARCHAR2,
p_preference_id IN NUMBER)
RETURN VARCHAR2
Returns the default value of the given preference
| Parameters |
| p_username |
The name of the directinfo user that is used for authorisation | |
| p_password |
The password of the directinfo user that is used for authorisation | |
| p_preference_id |
The id of the preference which default value the function gets |
Set_Preference_Default_Value
Procedure Set_Preference_Default_Value(p_username IN VARCHAR2,
p_password IN VARCHAR2,
p_preference_id IN NUMBER,
p_default_value IN VARCHAR2)
Updates the default value of the given preference
| Parameters |
| p_username |
The name of the directinfo user that is used for authorisation | |
| p_password |
The password of the directinfo user that is used for authorisation | |
| p_preference_id |
The id of the preference which default value the function sets | |
| p_default_value |
The value to be set to the preference as default |
Get_Config_Parameter_Value
Function Get_Config_Parameter_Value(p_username IN VARCHAR2,
p_password IN VARCHAR2,
p_config_id IN NUMBER) RETURN VARCHAR2
Returns the value of the given configuration parameter
| Parameters |
| p_username |
The name of the directinfo user that is used for authorisation | |
| p_password |
The password of the directinfo user that is used for authorisation | |
| p_config_id |
The id of the configuration parameter which value the function gets |
Set_Config_Parameter_Value
Procedure Set_Config_Parameter_Value(p_username IN VARCHAR2,
p_password IN VARCHAR2,
p_config_id IN NUMBER,
p_value IN VARCHAR2)
Updates the value of the given configuration parameter
| Parameters |
| p_username |
The name of the directinfo user that is used for authorisation | |
| p_password |
The password of the directinfo user that is used for authorisation | |
| p_config_id |
The id of the configuration parameter which value the function sets | |
| p_value |
The value to be set to the configuration parameter |
Create_Document_Group
Function Create_Document_Group(p_username IN VARCHAR2,
p_password IN VARCHAR2,
p_item_name IN VARCHAR2,
p_item_descr IN VARCHAR2 DEFAULT NULL,
p_use_compressed_cache IN VARCHAR2 DEFAULT 'Y')
RETURN NUMBER
Creates a new document group
| Parameters |
| p_username |
The name of the directinfo user that is used for authorisation | |
| p_password |
The password of the directinfo user that is used for authorisation | |
| p_item_name |
The name of the document group to be created | |
| p_item_descr |
The description of the document group to be created | |
| p_use_compressed_cache |
A value indicationg whether to use compressed cache |
Delete_Document_Group
Procedure Delete_Document_Group(p_username IN VARCHAR2,
p_password IN VARCHAR2,
p_group_id IN owa.vc_arr)
Deletes the specified document group
| Parameters |
| p_username |
The name of the directinfo user that is used for authorisation | |
| p_password |
The password of the directinfo user that is used for authorisation | |
| p_group_id |
An array of ids of the document groups to be deleted |
Update_Document_Group
Procedure Update_Document_Group(p_username IN VARCHAR2,
p_password IN VARCHAR2,
p_item_id IN NUMBER,
p_item_name IN VARCHAR2,
p_item_descr IN VARCHAR2 DEFAULT NULL)
Updates the specified document group
| Parameters |
| p_username |
The name of the directinfo user that is used for authorisation | |
| p_password |
The password of the directinfo user that is used for authorisation | |
| p_item_id |
The id of the document group to be updated | |
| p_item_name |
The new name of the document group | |
| p_item_descr |
The new description of the document group |
Create_Initial_Path
Procedure Create_Initial_Path(p_username IN VARCHAR2,
p_password IN VARCHAR2,
p_item_id IN NUMBER,
p_item_detail_loc IN VARCHAR2,
p_location_type IN VARCHAR2 DEFAULT NULL,
p_item_detail_depth IN NUMBER DEFAULT NULL,
p_include_paths IN VARCHAR2 DEFAULT NULL,
p_exclude_paths IN VARCHAR2 DEFAULT NULL,
p_new_username IN VARCHAR2 DEFAULT NULL,
p_new_password IN VARCHAR2 DEFAULT NULL,
p_defined_by_unc IN VARCHAR2 DEFAULT 'N',
p_mail_server_type IN VARCHAR2 DEFAULT NULL,
p_port IN NUMBER DEFAULT NULL,
p_ldap_base IN VARCHAR2 DEFAULT NULL,
p_ldap_query IN VARCHAR2 DEFAULT NULL,
p_cset IN VARCHAR2 DEFAULT NULL,
p_sis_partner IN VARCHAR2 DEFAULT NULL,
p_process_zip_files IN VARCHAR2 DEFAULT 'N',
p_url_location IN VARCHAR2 DEFAULT NULL)
Creates a new initial path
| Parameters |
| p_username |
The name of the directinfo user that is used for authorisation | |
| p_password |
The password of the directinfo user that is used for authorisation | |
| p_item_id |
The id of the document group of the initiol path | |
| p_item_detail_loc |
Initial location from where the document indexing starts | |
| p_location_type |
The type of the location of the initiol path | |
| p_item_detail_depth |
Depth to which the indexing will stop. For web documents it is recommended to be smaller | |
| p_include_paths |
The paths to be included in the indexing process | |
| p_exclude_paths |
The paths to be excluded from the indexing process | |
| p_new_username |
User | |
| p_new_password |
Password | |
| p_defined_by_unc |
Defined by UNC path | |
| p_mail_server_type |
The type of the mail server | |
| p_port |
Port | |
| p_ldap_base |
Starting node in LDAP tree | |
| p_ldap_query |
The LDAP query | |
| p_cset |
The default cset | |
| p_sis_partner |
The custom partner | |
| p_process_zip_files |
Whether to precess zip files | |
| p_url_location |
URL location for accessing files |
Update_Initial_Path
Procedure Update_Initial_Path(p_username IN VARCHAR2,
p_password IN VARCHAR2,
p_item_id IN NUMBER,
p_item_detail_id IN NUMBER,
p_item_detail_loc IN VARCHAR2,
p_location_type IN VARCHAR2,
p_item_detail_depth IN NUMBER DEFAULT NULL,
p_include_paths IN VARCHAR2 DEFAULT NULL,
p_exclude_paths IN VARCHAR2 DEFAULT NULL,
p_new_username IN VARCHAR2 DEFAULT NULL,
p_new_password IN VARCHAR2 DEFAULT NULL,
p_defined_by_unc IN VARCHAR2 DEFAULT 'N',
p_mail_server_type IN VARCHAR2 DEFAULT NULL,
p_port IN NUMBER DEFAULT NULL,
p_ldap_base IN VARCHAR2 DEFAULT NULL,
p_ldap_query IN VARCHAR2 DEFAULT NULL,
p_cset IN VARCHAR2 DEFAULT NULL,
p_sis_partner IN VARCHAR2 DEFAULT NULL,
p_process_zip_files IN VARCHAR2 DEFAULT 'N',
p_url_location IN VARCHAR2 DEFAULT NULL)
Updates the specified initial path
| Parameters |
| p_username |
The name of the directinfo user that is used for authorisation | |
| p_password |
The password of the directinfo user that is used for authorisation | |
| p_item_id |
The id of the document group of the initiol path | |
| p_item_detail_id |
The id of the initial path | |
| p_item_detail_loc |
Initial location from where the document indexing starts | |
| p_location_type |
The type of the location of the initiol path | |
| p_item_detail_depth |
Depth to which the indexing will stop. For web documents it is recommended to be smaller | |
| p_include_paths |
The paths to be included in the indexing process | |
| p_exclude_paths |
The paths to be excluded from the indexing process | |
| p_new_username |
User | |
| p_new_password |
Password | |
| p_defined_by_unc |
Defined by UNC path | |
| p_mail_server_type |
The type of the mail server | |
| p_port |
Port | |
| p_ldap_base |
Starting node in LDAP tree | |
| p_ldap_query |
The LDAP query | |
| p_cset |
The default cset | |
| p_sis_partner |
The custom partner | |
| p_process_zip_files |
Whether to precess zip files | |
| p_url_location |
URL location for accessing files |
Delete_Initial_Path
Procedure Delete_Initial_Path(p_username IN VARCHAR2,
p_password IN VARCHAR2,
p_item_id IN NUMBER,
p_item_detail_id IN NUMBER)
Deletes the specified initial path
| Parameters |
| p_username |
The name of the directinfo user that is used for authorisation | |
| p_password |
The password of the directinfo user that is used for authorisation | |
| p_item_id |
The id of the document group of the initial path | |
| p_item_detail_id |
The id of the initial path |
Restart_Job
Procedure Restart_Job(p_username IN VARCHAR2,
p_password IN VARCHAR2,
p_item_id IN NUMBER,
p_force_reindex_all IN VARCHAR2 DEFAULT '')
Restarts the indexing of the specified document group
| Parameters |
| p_username |
The name of the directinfo user that is used for authorisation | |
| p_password |
The password of the directinfo user that is used for authorisation | |
| p_item_id |
The id of the document group | |
| p_force_reindex_all |
Resume_Job
Procedure Resume_Job(p_username IN VARCHAR2,
p_password IN VARCHAR2,
p_item_id IN NUMBER)
Resumes the indexing of the specified document group
| Parameters |
| p_username |
The name of the directinfo user that is used for authorisation | |
| p_password |
The password of the directinfo user that is used for authorisation | |
| p_item_id |
The id of the document group |
Stop_Job
Procedure Stop_Job(p_username IN VARCHAR2,
p_password IN VARCHAR2,
p_item_id IN NUMBER)
Stops the indexing of the specified document group
| Parameters |
| p_username |
The name of the directinfo user that is used for authorisation | |
| p_password |
The password of the directinfo user that is used for authorisation | |
| p_item_id |
The id of the document group |
Create_Schedule
Procedure Create_Schedule(p_username IN VARCHAR2,
p_password IN VARCHAR2,
pGroupId IN NUMBER DEFAULT NULL,
pProcessId IN VARCHAR2 DEFAULT Processes_API.PROCESS_CRAWL_AND_INDEX,
pType IN VARCHAR2 DEFAULT Schedules_API.CYCLE_ONCE,
pDay IN OWA.VC_ARR DEFAULT ts_search.empty_vc_arr,
pStartDay IN VARCHAR2 DEFAULT NULL,
pStartDate IN VARCHAR2 DEFAULT NULL,
pStartTime IN VARCHAR2,
pStopDay IN VARCHAR2 DEFAULT NULL,
pStopDate IN VARCHAR2 DEFAULT NULL,
pStopTime IN VARCHAR2 DEFAULT NULL,
pSnapToME IN VARCHAR2 DEFAULT '0')
Creates a new schedule
| Parameters |
| p_username |
The name of the directinfo user that is used for authorisation | |
| p_password |
The password of the directinfo user that is used for authorisation | |
| pGroupId |
The document group id | |
| pProcessId |
The process type | |
| pType |
The recurrence type | |
| pDay |
In a CYCLE_DAY recurrence, an array with the days on which to run the schedule | |
| pStartDay |
The day when the schedule starts | |
| pStartDate |
The date when the schedule starts | |
| pStartTime |
The time when the schedule starts | |
| pStopDay |
The day when the schedule stops | |
| pStopDate |
The date when the schedule stops | |
| pStopTime |
The time when the schedule stops | |
| pSnapToME |
Convert to real month end |
Update_Schedule
Procedure Update_Schedule(p_username IN VARCHAR2,
p_password IN VARCHAR2,
pScheduleId IN NUMBER DEFAULT NULL,
pCustomId IN NUMBER DEFAULT NULL,
pDay IN OWA.VC_ARR DEFAULT ts_search.empty_vc_arr,
pStartDay IN VARCHAR2 DEFAULT NULL,
pStartDate IN VARCHAR2 DEFAULT NULL,
pStartTime IN VARCHAR2,
pStopDay IN VARCHAR2 DEFAULT NULL,
pStopDate IN VARCHAR2 DEFAULT NULL,
pStopTime IN VARCHAR2 DEFAULT NULL,
pSnapToME IN VARCHAR2 DEFAULT '0')
Updates the specified schedule
| Parameters |
| p_username |
The name of the directinfo user that is used for authorisation | |
| p_password |
The password of the directinfo user that is used for authorisation | |
| pScheduleId |
The id of the schedule to be updated | |
| pCustomId |
The custom id of the schedule to be updated | |
| pDay |
In a CYCLE_DAY recurrence, an array with the days on which to run the schedule | |
| pStartDay |
The day when the schedule starts | |
| pStartDate |
The date when the schedule starts | |
| pStartTime |
The time when the schedule starts | |
| pStopDay |
The day when the schedule stops | |
| pStopDate |
The date when the schedule stops | |
| pStopTime |
The time when the schedule stops | |
| pSnapToME |
Convert to real month end |
Delete_Schedule
Procedure Delete_Schedule(p_username IN VARCHAR2,
p_password IN VARCHAR2,
pScheduleId IN NUMBER DEFAULT NULL,
pCustomId IN NUMBER DEFAULT NULL)
Deletes the schedule and schedule processes with the specified schedule id and the schedule and schedule processes with the specified cusom id
| Parameters |
| p_username |
The name of the directinfo user that is used for authorisation | |
| p_password |
The password of the directinfo user that is used for authorisation | |
| pScheduleId |
The id of the schedule to be updated | |
| pCustomId |
The custom id of the schedule to be updated |
Delete_Expired_Schedules
Procedure Delete_Expired_Schedules(p_username IN VARCHAR2,
p_password IN VARCHAR2,
pGroupId IN NUMBER DEFAULT NULL)
Deletes all expired schedules, or if a document group is specified deletes its expired schedules
| Parameters |
| p_username |
The name of the directinfo user that is used for authorisation | |
| p_password |
The password of the directinfo user that is used for authorisation | |
| pGroupId |
Document group id of the schedules to be deleted |