Oracle Fusion Cloud ERP Jobs: Setting Properties Through Scripts

This page includes the following:

The attributes available for Download Jobs are the following:

• connection

  Defines the value of the Oracle Fusion Cloud ERP Connection object

  Value: text

• downloadOptions

  Defines the available download options:

  Value: Download File from UCM Integration Service

  • downloadTypeForUCMIntegration

    Defines the download type.

    Value: Using document ID

    • documentIdForUCMIntegration

      Defines the numeric document identifier of the document from UCM

      Value: Text

    • fileName

      Defines the file name of the content to download.

      Value: Text

    Value: Using File Prefix

    • filePrefix

      Defines the prefix with which the document title starts.

      Value: Text

    • documentAccount

      Defines the UCM account of the document if it belongs to the FAFusionImportExport security group.

      Value: Text

    • comments

      Defines the parameters to pass the comments.

      Value: Text

  Value: Download File from UCM

  • downloadTypeForUCM

    Defines the download type:

    Value: Using document ID

    • documentIdForUCM

      Defines the numeric document identifier of the document from UCM

      Value: Text

    Value: Using Query Text

    • queryText

      Defines the search expression.

      Value: Text

    • resultCount

    Defines the number of records that should be retrieved.

    Value: Text

  Value: Download BICC ESS Job Output Manifest and Associated Files

  • requestIdForBICC

    Defines the ESS Job Request ID.

    Value: Text

  • enableRequestIdDirectory

  Enables or disables the creation of the Request ID directory which is not part of the Oracle WSDL.

  Value: Yes/No

  Value: Download ERP Integration Services ESS Job Execution Details

  • requestIdForERP

    Defines the ESS Job Request ID.

    Value: Text

The attributes available for HCM Data Load Jobs are the following:

• connection

  Defines the value of the Oracle Fusion Cloud ERP Connection object

  Value: text

• ContentId

  Defines the content ID of the HCM data to be loaded.

  Value: text

• parametersInputType

  Defines the attributes that you want to pass to the application.

  Values: none, parametersFilePath, parametersJson

  • parametersFilePath

    Defines the path of the JSON file which contains the JSON parameters that you want to pass to the application.

  • parametersJson

    Enter the JSON payload definition. You can also use this field if you want to include this Job in a Workflow and you want to use Automation Engine variables in it.

The attributes available for Oracle Import Bulk Data Jobs are the following:

• connection

  Defines the value of the Oracle Fusion Cloud ERP Connection object

  Value: text

• filePath

  Defines the file path of the content to upload.

  Value: Text

• contentType

  Defines the type of content to upload.

  Value: Text

• documentAccount

  Defines the account under which the file is uploaded.

  Value: Text

• documentAuthor

  Defines the author of the document.

  Value: Text

• documentName

  Defines the name of the document.

  Value: Text

• documentSecurityGroup

  Defines a fixed value used to import and export the documents on the UCM server from Oracle Fusion.

  Value: Text

• documentTitle

  Defines the title of the document.

  Value: Text

• fileName

  Defines the name of the file on the UCM server.

  Value: Text

• importProcessId

  Defines the import process ID which identifies the type of data to import.

  Value: Text

• evaluateChildStatuses

  Enables or disables the evaluation of child job statuses.

  Value: Yes/No

• downloadExecutionDetails

  Enables or disables the download permission details for the file to be downloaded.

  Value: Yes/No

The attributes available for Oracle ERP Cloud Jobs are the following:

• connection

  Defines the value of the Oracle Fusion Cloud ERP Connection object

  Value: text

The attributes available for Run Flow Jobs are the following:

• connection

  Defines the value of the Oracle Fusion Cloud ERP Connection object

  Value: text

• flowName

  Defines the name of the Flow.

  Value: text

• flowInstanceName

  Defines the name of the Flow instance where the Flow is defined.

  Value: text

• dataGroupName

  Defines the Legislative data group name.

  Value: text

• recurringFlag

  Defines whether the job is recurring or not.

  Value: Yes/No

• parametersInputType

  Defines the attributes that you want to pass to the application.

  Values: none, parametersFilePath, parametersJson

  • parametersFilePath

    Defines the path of the JSON file which contains the JSON parameters that you want to pass to the application.

  • parametersJson

    Enter the JSON payload definition. You can also use this field if you want to include this Job in a Workflow and you want to use Automation Engine variables in it.

The attributes available for Schedule Report Jobs are the following:

• connection

  Defines the value of the Oracle Fusion Cloud ERP Connection object

  Value: text

• bookBindingOutputOption

  Enables or disables the book binding option for output files.

  Value: Yes/No

• compressDeliveryOutputOption

  Enables or disables compression for output delivery.

  Value: Yes/No

• dataModelURL

  Defines the URL of the data model associated with the report. This URL defines the structure and queries used to generate the report.

  Value: Text

• deliveryChannelsType

  Defines the delivery channels to be used for the report. They define how and where the report output will be sent, including options like email, FTP, or other designated destinations.

  Value: none, XML, XML File Path

  • xmlForDeliveryChannelsType

    Defines the XML.

    Value: Text

  • xmlFilePathForDeliveryChannelsType

    Defines the XML file path.

  • Value: Text

• endDate

  Defines the end date for the job execution which is the final date the job is scheduled to run.

  Value: Text

• jobLocale

  Defines the locale setting for the job which defines the language, date, time, and other locale-specific preferences that will be applied during the job's execution.

  Value: Text

• jobTimezone

  Defines the time zone in which the job is scheduled to run, which ensures the job runs at the correct local time based on the specified time zone.

  Value: Text

• mergeOutputOption

  Enables or disables the merging of outputs into a single file. When enabled, the outputs from multiple tasks or reports will be combined into one document.

  Value: Yes/No

• notificationPassword

  Defines the server address used for sending job notifications, which could be an email server or any other type of notification service.

  Value: Text

• notificationTo

  Defines the recipient(s) of job notifications. This can include email addresses or other notification endpoints.

  Value: Text

• notificationUserName

  Defines the user name required to authenticate with the notification server.

  Value: Text

• notifyHttpWhenFailed

  Enables or disables HTTP notifications when a job fails. If enabled, an HTTP request will be sent to the specified endpoint on job failure. Defines the user name required to authenticate with the notification server.

  Value: Yes/No

• notifyHttpWhenSkipped

  Enables or disables HTTP notifications when a job is skipped. If enabled, an HTTP request will be sent to the specified endpoint when the job is skipped.

  Value: Yes/No

• notifyHttpWhenSuccess

  Enables or disables HTTP notifications when a job succeeds. If enabled, an HTTP request will be sent to the specified endpoint on job success.

  Value: Yes/No

• notifyHttpWhenWarning

  Enables or disables HTTP notifications when a job completes with warnings. If enabled, an HTTP request will be sent to the specified endpoint when a warning occurs.

  Value: Yes/No

• notifyWhenFailed

  Enables or disables notifications (via configured channels) when a job fails. Doing so allows you to control whether the recipient will be alerted about job failures.

  Value: Yes/No

• notifyWhenSkipped

  Enables or disables notifications when a job is skipped. This controls whether the recipient will be alerted about jobs that are not executed.

  Value: Yes/No

• notifyWhenSuccess

  Enables or disables notifications when a job is completed successfully. This ensures that the recipient is informed of successful job completion.

  Value: Yes/No

• notifyWhenWarning

  Enables or disables notifications when a job is complete with warnings. This controls whether the recipient is alerted about potential issues in the job.

  Value: Yes/No

• recurrenceExpression

  Defines the expression used to specify the recurrence pattern of the job. This determines how often the job should be repeated.

  Value: Text

• recurrenceExpressionType

  Defines the type of recurrence expression used such as cron, interval, or other predefined patterns. This defines the format and interpretation of the recurrence expression.

  Value: Text

• repeatCount

  Defines the number of times the job should be repeated. This specifies the total count of executions before the job is completed.

  Value: Number

• repeatInterval

  Defines the time interval between consecutive job executions. This is measured in the appropriate time unit.

  Value: Number

• deliveryChannelsType

  Defines the report to be generated, including any parameters or options required for report execution.

  Value: none, XML, XML File Path

  • xmlForReportRequestType

    Defines the XML.

    Value: Text

  • xmlFilePathForReportRequestType

    Defines the XML file path.

  • Value: Text

• saveDataOption

  Enables or disables the saving of data associated with the job. When enabled, the data used or generated by the job will be saved for future reference.

  Value: Yes/No

• saveOutputOption

  Enables or disables the saving of the output generated by the job. When enabled, the output files will be stored for future access.

  Value: Yes/No

• startDate

  Defines the start date for the job execution which indicates the initial date when the job is scheduled to begin.

  Value: Text

• useUTF8Option

  Enables or disables the use of UTF-8 encoding for the job output. When enabled, all output will be encoded in UTF-8.

  Value: Yes/No

• userJobDesc

  Defines a description of the job.

  Value: Text

• userJobName

  Defines the name that should be assigned to the job.

  Value: Text

The attributes available for Submit BICC Request Jobs are the following:

• connection

  Defines the value of the Oracle Fusion Cloud ERP Connection object

  Value: text

• application

  Defines the application where the job is defined.

  Value: text

• packageName

  Defines the package name where the job is defined.

  Value: text

• jobType

  Defines the job type of job definition

  Value: JOB_DEFINITION, JOB_SET

• jobDefinitionName

  Defines the job definition name to submit.

  Value: text

• description

  Defines the description of this request; the value is displayed in the Oracle UI in the Submission Notes field.

  Value: text

• parametersInputType

  Defines the attributes that you want to pass to the application.

  Values: none, parametersFilePath, parametersJson

  • parametersFilePath

    Defines the path of the JSON file which contains the JSON parameters that you want to pass to the application.

  • parametersJson

    Enter the JSON payload definition. You can also use this field if you want to include this Job in a Workflow and you want to use Automation Engine variables in it.

• enableRequestIdDirectory

  Defines if specific permission details are defined.

  Value: Yes/No

The attributes available for ESS Jobs are the following:

• connection

  Defines the value of the Oracle Fusion Cloud ERP Connection object

  Value: text

• application

  Defines the application where the job is defined.

  Value: text

• packageName

  Defines the package name where the job is defined.

  Value: text

• jobType

  Defines the job type of the job definition

  Value: JOB_DEFINITION, JOB_SET

• jobDefinitionName

  Defines the job definition name to submit.

  Value: text

• description

  Defines the description of this request; the value is displayed in the Oracle UI in the Submission Notes field.

  Value: text

• parametersInputType

  Defines the attributes that you want to pass to the application.

  Values: none, parametersFilePath, parametersJson

  • parametersFilePath

    Defines the path of the JSON file which contains the JSON parameters that you want to pass to the application.

  • parametersJson

    Enter the JSON payload definition. You can also use this field if you want to include this Job in a Workflow and you want to use Automation Engine variables in it.

• evaluateChildStatuses

  Defines when child statuses are checked.

  Value: Yes/No

• downloadExecutionDetails

  Defines if execution details are downloaded.

  Value: Yes/No

The attributes available for Upload File to UCM Jobs are the following:

• connection

  Defines the value of the Oracle Fusion Cloud ERP Connection object

  Value: text

• jobType

  Defines the job type for the upload job.

  Value: Upload File to UCM, Upload File to UCM with Generic SOAP Service

• filePath

  Defines the file path of the content you want to upload.

  Value: Text

• contentType

  Defines the type of content uploaded such as .zip, .txt, or .csv.

  Value: Text

• documentAccount

  Defines the account under which the file is uploaded.

  Value: Text

• documentAuthor

  Defines the author of the document.

  Value: Text

• documentName

  Defines the name of the document.

  Value: Text

• documentSecurityGroup

  Defines a fixed value used to import and export the documents on the UCM server from Oracle Fusion

  Value: Text

• documentTitle

  Defines the title of the document.

  Value: Text

• fileName

  Defines the name of the file.

  Value: Text

The attributes available for the Download File Parameters are:

• connection

  Defines the value of the Oracle Fusion Cloud ERP Connection object

  Value: text

• downloadDirectory

  Defines the download directory.

  Value: Text

• filePermission

  Defines the permissions on the file to be downloaded.

  Value: Text

• fileOwner

  Defines the file owner.

  Value: Text

• fileOwnerGroup

  Defines the file owner group.

  Value: Text