/
Launch Job (LAUNCH_API)


Launch Job (LAUNCH_API)

Owned by IFS Energy and Resources (Deactivated)
Last updated: Feb 14, 2024 by Bobby Lo (Unlicensed)
6 min read



Back to Qbyte 360 Connect API Reference Guide

Overview

Uses job submissions to launch a Qbyte IM job. The functions and procedures are:

Function Name

Purpose

Function Name

Purpose

launch_module

Launches the specified Qbyte IM module.

launch_revu055

Launches REVU055 and optionally ACTU116.

launch_revu066

Launches REVU066 and optionally ACTU116.

launch_actu204

Launches ACTU204 and optionally ACTU116.

launch_actu213

Launches ACTU213.

Procedure Name

Purpose

Procedure Name

Purpose

launch_module

Launches the specified Qbyte IM module.

launch_revu055

Launches REVU055 and optionally ACTU116.

launch_revu066

Launches REVU066 and optionally ACTU116.

launch_actu204

Launches ACTU204 and optionally ACTU116.

launch_actu213

Launches ACTU213.



launch_api.LAUNCH_MODULE

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • The parameter_list values are separated by semi-colons. The first parameter must be the module_id.

  • The parameter values are positional and must be in the same sequence as defined for the module. 

  • The end of the parameter list is indicated by a period. Example - 'REVU055;;03/05;;Y;filename.txt;.'

  • Default values on parameters indicate that the parameter is optional and the default value will be inserted into the corresponding column.

  • Available as both a function and a procedure.

Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_parameter_list

IN

VARCHAR2(240)



i_parent_report_id

IN

NUMBER(10)

NULL.  Use this to establish dependencies between jobs.

o_report_id

OUT

NUMBER(10)

The report_id created for the new job.

o_return_status



*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message



launch_api.LAUNCH_REVU055

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • To automatically launch actu116 set i_launch_batch_edit to Y.

  • Default values on parameters indicate that the parameter is optional and the default value will be inserted into the corresponding column.

  • Available as both a function and a procedure.

Parameter

In/Out

Type

Default Value

i_org_id

IN

VARCHAR2(240)

NULL.  This is an optional parameter and does not need to be specified if processing all organizations in the flat file.

i_acct_per_date

IN

VARCHAR2(240) 



i_voucher_num

IN

VARCHAR2(240)

NULL.  This is an optional parameter and does not need to be specified if processing all the voucher numbers in the flat file. 

i_load_upload_data_files

IN

VARCHAR2(1)

‘N’

i_pa_filename

IN

VARCHAR2(240)

NULL 

i_print_detail_report

IN

VARCHAR2(1)

‘N’ 

i_launch_batch_edit

IN

VARCHAR2(1)

‘N’ 

o_report_id

OUT

NUMBER(10)

The report_id created for the new job. 

o_return_status



*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’ 

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error 

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message 



launch_api.LAUNCH_REVU066

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • To automatically launch actu116 set i_launch_batch_edit to Y.

  • Default values on parameters indicate that the parameter is optional and the default value will be inserted into the corresponding column.

  • Available as both a function and a procedure.

Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_org_id

IN

VARCHAR2(240)

NULL.  This is an optional parameter and does not need to be specified if processing all organizations in the flat file. 

i_acct_per_date

IN

VARCHAR2(240)



i_voucher_num

IN

VARCHAR2(240)

NULL.  This is an optional parameter and does not need to be specified if processing all the voucher numbers in the flat file. 

i_metrix_batch_num

IN

VARCHAR2(240)

NULL 

i_load_upload_data_files

IN

VARCHAR2(1)

‘N’ 

i_pa_filename

IN

VARCHAR2(240)

NULL 

i_print_detail_report

IN

VARCHAR2(1)

‘N’ 

i_launch_batch_edit

IN

VARCHAR2(1)

‘N’ 

o_report_id

OUT

NUMBER(10)

The report_id created for the new job. 

o_return_status



*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’ 

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error 

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message



launch_api.LAUNCH_ACTU204

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • To automatically launch actu116 set i_launch_batch_edit to Y.

  • Default values on parameters indicate that the parameter is optional and the default value will be inserted into the corresponding column.

  • Available as both a function and a procedure.

Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value 

i_org_id

IN

VARCHAR2(240)

This is not an optional parameter and needs to be specified 

i_acct_per_date

IN

VARCHAR2(240)

This is not an optional parameter and needs to be specified 

I_mineral_surface_road

IN

VARCHAR2(1)

This is not an optional parameter and needs to be specified

I_activity_date

IN

VARCHAR2(240)



NULL. This is an optional parameter and does not need to be specified. If left out it will default to the value provided in the system defaults.

i_launch_batch_edit

IN

VARCHAR2(1)

‘N’ 

o_report_id

OUT

NUMBER(10)

The report_id created for the new job. 

o_return_status



*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’ 

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error 

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message 



launch_api.LAUNCH_REVU066 (with PA USER ID Parameter)

  • A new function/procedure was added for enhancements made in Qbyte Metrix 1.4. This overloaded procedure/function has a new parameter for the PA User ID that will be supplied by the Qbyte Metrix application.

  • The new overloaded function/procedure will issue an update statement to update the CREATE_USER column on the AU_JOB_SUBMISSIONS table for the REVU066 right after the call to launch_fa_module.

  • The function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • To automatically launch actu116 set i_launch_batch_edit to Y.

  • Default values on parameters indicate that the parameter is optional and the default value will be inserted into the corresponding column.

  • Available as both a function and a procedure.

Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value 

i_org_id

IN

VARCHAR2(240)

NULL.  This is an optional parameter and does not need to be specified if processing all organizations in the flat file.

i_acct_per_date

IN

VARCHAR2(240)



i_voucher_num

IN

VARCHAR2(240)

NULL.  This is an optional parameter and does not need to be specified if processing all the voucher numbers in the flat file. 

i_metrix_batch_num

IN

VARCHAR2(240)

NULL 

i_load_upload_data_files

IN

VARCHAR2(1)

‘N’ 

i_pa_filename

IN

VARCHAR2(240)

NULL 

i_print_detail_report

IN

VARCHAR2(1)

‘N’ 

i_launch_batch_edit

IN

VARCHAR2(1)

‘N’ 

i_pa_user

IN

VARCHAR2(30)

NULL.  This is an optional parameter. 

o_report_id

OUT

NUMBER(10)

The report_id created for the new job. 

o_return_status



*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’ 

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error 

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message 



launch_api.LAUNCH_ACTU213

  • Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.

  • Default values on parameters indicate that the parameter is optional and the default value will be inserted into the corresponding column.

  • Available as both a function and a procedure.

Parameter

In/Out

Type

Default Value

Parameter

In/Out

Type

Default Value

i_load_upload_data_files

IN 

VARCHAR2(1)

‘N’

i_upload_file_name

IN 

VARCHAR2(240)

NULL

i_batch_report_id

IN 

VARCHAR2(10)

NULL

i_override_user_id

IN 

VARCHAR2(240)

NULL

o_report_id

OUT

NUMBER(10)

The report_id created for the new job. 

o_return_status



*procedure only

OUT

VARCHAR2

Possible values:

  • ‘TRUE’

  • ‘FALSE’

o_return_code

OUT

NUMBER

Possible values:

  • 0 – Success

  • -20001 – Handled Application Error

  • -20000 – Generic Error

o_return_message

OUT

VARCHAR2

Insert ‘Successful’ or ‘Failure’ or error message



Error Messages for LAUNCH_REVU055()

Message

Explanation

Message

Explanation

Accounting Period (i_acct_per_date) must be specified to launch REVU055. 

The accounting period cannot be null and must be supplied for processing REVU055.

Load (i_load_upload_data_files) parameter is ### but it must be set to Y or N. 

The i_load_upload_data_files parameter value is not ‘Y’ or ‘N’.

Filename (i_pa_filename) must be specified to upload data.

If the i_load_upload_data_files parameter is ‘Y’ then a filename must be supplied.

Print Detail Report (i_print_detail_report) parameter is ### but it must be set to Y or N. 

The i_print_detail_report parameter value is not ‘Y’ or ‘N’.

Launch Batch Edit (i_launch_batch_edit) parameter is ### but it must be set to Y or N. 

The i_launch_batch_edit parameter value is not ‘Y’ or ‘N’.



Error Messages for LAUNCH_ACTU213()

Message

Explanation

Message

Explanation

Load (i_load_upload_data_files) parameter is ### but it must be set to Y or N.

The i_load_upload_data_files parameter value is not ‘Y’ or ‘N’.

Batch ID (i_batch_report_id) must be specified when not uploading files. 

If the i_load_upload_data_files parameter is ‘N’ then a batch ID must be specified.

Filename (i_upload_file_name) must be specified to upload data. 

If the i_load_upload_data_files parameter is ‘Y’ then a filename must be supplied.



Error Messages for LAUNCH_ACTU204()

Message

Explanation

Message

Explanation

Organization ID (i_org_id) must be specified to launch ACTU204 

The organization id cannot be null and must be supplied for processing ACTU204.

Accounting Period End Date(i_acct_per_date) must be specified to launch ACTU204. 

The accounting period end date cannot be null and must be supplied for processing ACTU204.

Mineral/Surface/Road (i_mineral_surface_road) must be specified to launch ACTU204 

The i_mineral_surface_road parameter cannot be null and must be supplied for processing ACTU204.

Mineral/Surface/Road (i_mineral_surface_road) parameter is #### but it must be set to M or S or R. 

The i_mineral_surface_road parameter value is not ‘M’ or ‘S’ or ‘R’.

Launch Batch Edit (i_launch_batch_edit) parameter is ### but it must be set to Y or N.

The i_launch_batch_edit parameter value is not ‘Y’ or ‘N’.

 

 

Related content

Copyright© 2024 IFS AB. Copying prohibited. All rights reserved.