4 Configuration and Administration
Document Management (My Docs)
Purpose: Use the Document Management screen to work with reports generated by Order Management System.
How are reports different from forms? Reports are listings that present summary or detail information for use by staff, while forms include specific information for a single customer, vendor, or order, and are available for distribution to the customer or vendor. For example, the Pick Unit report lists total single-line and multi-line picks generated, while each generated pick slip form includes the customer’s name and address and details about the order that is shipping with the pick.
PDF files: Each report is generated as a PDF (portable document format) file, typically opened through the Adobe Reader or within a separate browser window. Certain reports are also available in spreadsheet format, so you can work with them in a spreadsheet application.
Oracle Business Intelligence Publisher report settings: Order Management System uses an integration with Oracle Business Intelligence Publisher to generate certain forms and reports. See Oracle Business Intelligence Publisher (BI Publisher) Forms and Reports Settings for more information on the required setup.
Custom reports: You can create and generate custom reports through Oracle Analytics Cloud. See the OMS Custom Reporting Guide on My Oracle Support (2149144.1) for more information.
In this topic:
Document Management Screen
How to display this screen:
-
Click the My Docs icon (
) in the upper right area of a screen), or select My Docs from
an Admin screen (such as the About Application, Forms Management
Screen, Job Management Screen, Commands, User Control, or System Messages screens). When you advance
to the screen this way, it displays all reports generated through
your user ID through any submitted job. See the fields below for information
on how to filter the reports listed on this screen.
-
Click the report icon (
) for a submitted job at the Job Management Screen (My Jobs) to display the reports generated for that particular
job only.
Report Listings and Display Options
Default settings for reports available for review: When you first advance to this screen, the most recent reports submitted by your user ID are currently available for review by scrolling up or down with the right-hand scroll bar. The reports are listed in reverse chronological order (newest to oldest).
Available reports updated when you filter: When you enter or select any search criteria and then click Filter, the screen displays reports that match these criteria. A message displays if the search results are greater than 200 records: The maximum number of records was exceeded. Please refine search criteria. Showing records 1-200. Enter additional search criteria to refine your search results.
Example: The screen currently includes the most recent reports available for review in reverse chronological order (newest to oldest): 20 of these reports are in the QPRINT queue, and 5 are in the DOCUMENTS queue. When you select QPRINT from the Queue field and click Filter, the screen displays only the most recent reports in the QPRINT queue.
Available reports restricted by Rank and All job authority:
-
If the All job authority option is selected for your user control record, you can review all jobs, regardless of ranking.
-
If the All job authority option is not selected for your user control record, you can review forms generated by other users only if their user control Rank does not exceed yours.
Example:
User MSMITH has a Rank of 9, with All job authority selected.
User TBROWN has a Rank of 9, with All job authority unselected.
User JJONES has a Rank of 1, with All job authority selected.
Result:
-
MSMITH can review reports generated by TBROWN because their Rank is the same; however, MSMITH cannot review reports generated by JJONES, because a Rank of 1 exceeds a Rank of 9.
-
TBROWN cannot review reports generated by any other users, because he does not have All job authority.
-
JJONES can review reports generated by all other users based on his Rank and All job authority.
Note:
Different rules control the authority to view forms and reports than the rules that affect the Job Management Screen. The user’s Rank does not affect authority to view jobs.
Column sort: You can sort on any column by clicking the column heading name. When you first click, the sort is in ascending alphanumeric (A-Z) or numeric (lowest to highest) order. Click again to change the sort to descending (Z-A) or numeric (highest to lowest) order.
| Field | Description |
|---|---|
|
Document |
The program that generated the report. Click the document icon to open the report in a separate window. From this window, you can review and optionally print the report, using the standard Windows print options for your PC. Note:
Filter options:
|
|
Job name |
The job that generated the report. Filter options:
|
|
Output queue |
The output queue where the report is saved. The default output queue is QPRINT for some reports and DOCUMENTS for others. See Reports Troubleshooting for more information. Filter options:
|
|
Pages/File Size |
The size of the report file in kilobytes; for example: 10 KB. Any reports generated using a tool other than Oracle Business Intelligence Publisher display the report’s length in pages; for example: 10 Page(s). Note: If you advance to the Document Management screen before the job has finished generating the report, the value indicated here might not be correct until the job completes. |
|
Date |
The date and time when the report was generated in MM/DD/YY-HH:MM:SS. Filter options:
|
|
User name |
The user ID of the person who generated the report. Your user ID defaults. Submitted through web service request? When you use the CWProcessIn message or the ProcessIn message to start a periodic process, the report is listed under your default user set up during installation. Contact your cloud administrator or system administrator to confirm the user ID of the default user, and see Using the CWProcessIn Message to Start a Periodic Process or Using the ProcessIn REST Message to Start a Periodic Process in the Web Services Guide on My Oracle Support (ID 2149144.1)or for background. Filter options:
|
|
Status |
The only status currently implemented is READY (the report is ready for review). |
|
Job |
A system-assigned identification number to track the job generating the report. When you use the ProcessIn Message or the CWProcessIn Message to start a job with the wait_for_completion tag set to Y, this is the job number returned in the response message. Filter options:
|
) indicates that the report is available in PDF
format. Click the icon to open the report in a portable document format
application.
) indicates that the report has already
been reviewed in a prior session, by you or another user. If your
user ID is assigned a Rank of 1, you can click on this
icon to display a log indicating who viewed the report: Viewed
By: TBROWN on 05/29/2014 10:57:30
), select a date, and then click OK.
Document Management Screen Options
| Option | Procedure |
|---|---|
|
Review, and optionally print, a generated report |
Click the document icon to open the report in a separate window. From this window, you can print the report using the printers currently available to your local PC. Note: The system keeps a single additional window open for you to review a report or a form. If you already had a report or form open in the additional window, the system replaces the document previously displayed with the report you have just selected. Reopen the additional window to review the recently selected report. |
|
Change which reports are displayed on the screen |
|
|
Restrict or expand the list of displayed reports based on one of the available column headings |
See the Report Listings and Display Options for information on how to filter the reports displayed based on various criteria. |
|
Refresh data listed on the screen |
Click Refresh. Newly generated reports are added to the screen in READY status as they are generated. |
|
Sort by column |
Click the column heading name. When you first click, the sort is in ascending alphanumeric (A-Z) or numeric (lowest to highest) order. Click again to change the sort to descending (Z-A) or numeric (highest to lowest) order. |
|
Delete an individual report |
Select the checkbox to the left of a report and click Delete. |
|
Display additional information about a report or advance to a different screen |
If you advance to a different screen and then return, your filter entries are not retained. For example, if you are currently filtering on a specific queue, and you advance to the Job Management (My Jobs) screen and return, the Queue column no longer filters on that queue. |
|
Display information about Order Management System |
Select About. |
|
Advance to the Forms Management Screen screen |
Select My Forms. |
|
Advance to the Job Management Screen |
Select My Jobs. |
|
Advance to the Advanced Commands screen |
Select Advanced Commands. This option is available only for users that have authority to the Advanced Commands option. |
|
Return to the previous screen |
Select Exit. |
Reports Available in Spreadsheet Format
Purpose: Certain reports are available as spreadsheet files, which you can easily open in a spreadsheet application and then work with the data to suit your business requirements. Reports available in spreadsheet format are:
| Report | Fast Path |
|---|---|
|
LIPS |
|
|
Note: Only the sort by Category $ Sold Ascending and by Item $ Sold Ascending are available in spreadsheet format, but you can use your spreadsheet application to sort the data as needed. |
MISA |
|
Note: Only the sort by Item Warehouse is available in spreadsheet format, but you can use your spreadsheet application to sort the data as needed. |
MISS |
|
MRDU |
|
|
Backorder Report by Descending Dollars by Division/Warehouse Note: This is the only version of the backorder report by descending dollars that is available in spreadsheet format, but since the data is the same in other versions, you can use your spreadsheet application to sort the data as needed. |
PBOD |
|
PBOR |
|
|
PBOR |
|
|
PBOR |
|
|
PBOR |
|
|
PBOR |
|
|
PCOR |
|
|
Deposit History Detail Report |
PDHD |
|
PDHS |
|
|
PDSJ |
|
|
PDSJ |
|
|
PDTS |
|
|
PERR |
|
|
PERR |
|
|
The spreadsheet format is available regardless of whether you select the Print SKU detail option when you generate the report. |
PEXD |
|
PHOR |
|
|
PITH |
|
|
POCT |
|
|
POPA |
|
|
POPP |
|
|
Product Performance Report (Ordered Totals) Note: Only the sort by ascending items or by descending total dollars are available in spreadsheet format, but you can use your spreadsheet application to sort the data as needed. |
PPPR |
|
Product Performance Report (Shipped Totals) Note: Only the sort by ascending items or by descending total dollars are available in spreadsheet format, but you can use your spreadsheet application to sort the data as needed. |
PPPR |
|
PPRR |
|
|
PROR |
|
|
Sales Journal Summary by Period |
PSJM |
|
PSJP |
|
|
PSSR |
|
|
PSTD |
|
|
PSTX |
|
|
PUSA |
|
|
PUSA |
|
|
SDEP |
|
|
WOBR |
|
|
WSPS |
|
|
N/A (generated through SLSSMOT periodic function) |
Opening the file as a spreadsheet: The spreadsheet
icon (
) next to the report indicates that the report is available
in spreadsheet format (such as the FLR0393 report in the image below):
Click the spreadsheet icon to work with the report in your default spreadsheet application. A window opens asking if you would like to open or save the selected file.
Things to note:
-
Formatting: When you initially open the report in your spreadsheet application, the data might not be formatted to your preferences. For example, certain columns might appear too narrow to display their full contents. Also, alphanumeric fields that can also include numeric values (for example, the item code) might be in cells that are formatted as numeric data. In this situation, changing the cell properties to text can correct the alignment.
-
Decimal and Thousand Separators: Your spreadsheet application may override any decimal and thousand separator settings for numbers with its own number separators. Change the settings in the spreadsheet application to the separators you wish to use.
-
Totals: For the most part, totals and subtotals that appear on the PDF version of the report are not included in the spreadsheet file. You can use your spreadsheet application to insert rows for totals or subtotals and perform any required calculations.
-
Blank columns and rows: Columns and rows that can include data are included in the spreadsheet file, even if there is no relevant information for the column or row in your report results. For example, when a report includes a separate column to flag order lines that have VAT charges, this column is blank in your spreadsheet file if you do not charge VAT in your company.
-
Negative amounts: For negative amounts and quantities, the minus sign is on the left side in the spreadsheet file (rather than the right side, as it appears in the PDF version) so that your spreadsheet application can correctly render the negative values and include them in calculations.
-
Page breaks and column headings: Page breaks in the PDF version of the report are not represented in the spreadsheet file as repeated column headings unless they also introduce a new grouping of data. For example, the sales journals are each broken out into separate groupings, such as by invoice date and pay type, so in these reports the column headings repeat for each grouping in the spreadsheet file.
-
Automatic backup of spreadsheet files: If you leave a spreadsheet file open for a period without saving it, your spreadsheet application may display an error message. This error occurs because the spreadsheet application attempts to back up working files periodically, and the spreadsheet file name includes invalid characters. To avoid seeing this error message, save the spreadsheet file using a logical, valid file name soon after opening it.
-
Deletion of spreadsheet files: When you remove the report at the Document Management screen, the system deletes the selected spreadsheet file only; when you remove the job at the Job Management screen, the system deletes both the PDF file and the spreadsheet file.
Opening a spreadsheet file for a language other than English: When you use a spreadsheet application such as Microsoft Excel to open a spreadsheet file in a language other than English, the content might not display correctly. To open the file and use language-specific encoding, follow a process such as the following.
Note:
The exact steps vary depending on the spreadsheet application you use and the version of the application.
-
Download and save the CSV file.
-
Open a blank workbook in the spreadsheet application.
-
At the top of the screen, select Data > From Text or Data > Get External Data > From Text.
-
Locate the downloaded file and select Import.
-
In Step 1 of the Text Import wizard, select the Delimited option and in the File origin, select the correct language code. For example, for French, select 65001:Unicode(UTF-8). Click Next.
-
In Step 2, select Comma from the delimiters section. The Text qualifier field should then show a double quote. Click Next.
-
If the wizard prompts for where you want to put the data, click any cell on the blank worksheet to determine where the data should go.
-
If the wizard prompts for a column date format, select General.
-
If the Import Data window prompts for where to import the data, select the Existing worksheet, accept the default entry, and click OK.
-
-
Click Finish to import the data.
Reports Not Currently Implemented
Order Management System uses an integration with Oracle Business Intelligence Publisher to generate certain forms and reports. As part of the transition to Oracle Business Intelligence Publisher, if a report has not yet been converted to Oracle Business Intelligence Publisher, instead of generating the report the system will generate a generic document with the following information, where REPORT is the name of the generated report:
The requested document is not currently implemented: REPORT
The following reports are not currently implemented.
| Report | Fast Path or Function |
|---|---|
|
CPGIXUP periodic function |
|
|
PCUPLD periodic function |
|
|
WPRO or PRMOUPL periodic function |
|
|
PURGEOR periodic function |
|
|
OEOM |
|
|
STRUPLD periodic function |
|
|
MRPC |
|
|
MRQR |
|
|
MRBO |
|
|
MRIW |
|
|
MRSO |
|
|
SLSUPLD periodic function |
|
|
EMAILUD periodic function |
Reports Troubleshooting
Some possible troubleshooting questions and answers are:
| Question | Possible Answer(s) |
|---|---|
|
How is the system determining the date format for dates that display on reports? |
Reports and forms generated using Oracle Business Intelligence Publisher display the date in the date format defined in Oracle Business Intelligence Publisher for the locale in the Company table. Since the only locale supported is English, the date format for reports generated using Oracle Business Intelligence Publisher is always MM/DD/YY. Reports and forms that are not generated using Oracle Business Intelligence Publisher, display the date in the date format defined for the company. Note: Reports that are not associated with a company display the date in the date format defined for the DEFAULT_DATE_FORMAT property. |
|
How is the system determining the decimal and thousand separator for numbers that display on reports? |
Reports and forms generated using Oracle Business Intelligence Publisher use the number format defined in Oracle Business Intelligence Publisher for the locale in the Company table. Since the only locale supported is English, the decimal separator is always a period (.) and the thousand separator is always a comma (,). Reports and forms that are not generated using Oracle Business Intelligence Publisher display numbers using the characters defined in the DECIMAL_SEPARATOR and THOUSAND_SEPARATOR properties. |
|
Are reports automatically deleted? |
Reports older than the JOB_RETENTION_DAYS property in Working with Customer Properties (PROP) are deleted, along with the related jobs, when you restart Order Management System. |
|
Why are the outer portions of the page cut off when I print a report? |
Make sure that the Page scaling option in the Print dialog box is set to Fit to printer margins or Shrink to fit when printing a form to prevent information on the edge of the page from being cut off. |
|
Why doesn’t a new window open when I click the name of a report at the Document Management Screen? |
The system keeps a single additional window open for you to review a form or a report. If you already had a form or report open in the additional window, the system replaces the document previously displayed with the report you have just selected. Reopen the additional window to review the recently selected report. |
|
I removed a job at the Job Management Screen and now I cannot find the report. Why? |
Deleting a job automatically deletes the reports generated through that job. |
|
Why wasn’t a job deleted when I removed all of its generated reports at the Document Management Screen? |
Deleting all generated reports for a job does not automatically delete the job. Use the Job Management Screen (My Jobs) to delete the job. |
|
How can I find out about the data on a report? |
Use the Reports Guide find a description of the report and a report sample. |
|
Why is there a single line of detail information on page two of a report, and then the third page of the report is labelled “Page 2"? |
Contact your Order Management System representative if this issue occurs on one of your generated reports. |
|
Why does the Document Management Screen indicate that a report is 1 page long, while the report is actually longer? |
If you advance to the Document Management Screen while the report is still being generated, the number of pages indicated at the screen might be incorrect until the job completes. |
|
How can I improve the legibility of reports on the screen? |
If some reports are not displayed clearly, you can try setting the Smooth Text option (under Preferences > Page Display in your PDF reader, such as Adobe Acrobat) to For Laptop/LCD screens. |
Forms Management (My Forms)
Purpose: Use the Forms Management screen to work with personalized forms generated by Order Management System.
How are forms different from reports? Forms differ from regular reports (available for review through the Document Management Screen) in that each generated form includes specific information for a single customer, vendor, or order, and is available for distribution to the customer or vendor. For example, each generated pick slip form includes the customer’s name and address and details about the items that are shipping with the pick. Reports are listings that present summary or detail information for use by staff.
PDF files: Each form is generated as a PDF (portable document format) file which you can open in a separate window. Each PDF file can contain one or more individual forms. For example, when you generate pick slips, the system might produce a single PDF file containing all the pick slips generated at that time.
If there are no records eligible for forms when you submit a job, the system generates a blank (empty) PDF file. This might occur if, for example, you generate backorder cards a second time on the same day; in this situation, the first submitted job generated all eligible backorder cards, so the PDF generated the second time is blank.
Graphical or non-graphical? There are standard print programs available for each form. Some forms are available in a graphical format, including field labels and other graphical elements, such as a company logo, as well a simpler, non-graphical format consisting of text only. For example, you might choose a non-graphical format if you use pre-printed forms. The information on the form is the same regardless of whether you use the graphical or non-graphical format.
You can also use a unique print program if you require a form laid out differently from the standard. Contact your Order Management System representative if you need to develop a unique print program for a form.
In this topic:
Forms Setup
Oracle Business Intelligence Publisher (BI Publisher) Forms and Reports Settings
Order Management System uses an integration with Oracle Business Intelligence Publisher to generate certain forms and reports.
In order for the integration to work, you must complete the following setup.
Oracle Business Intelligence Publisher Properties
The following properties are in the Working with Admin Properties (CPRP) menu option.
| Property Name | Description |
|---|---|
|
BI_BYPASS_CACHE_ENABLE |
Defines whether the system bypasses caching for reports generated using Oracle Business Intelligence Publisher. true = Bypass caching for reports generated using Oracle Business Intelligence Publisher. false = Cache reports generated using Oracle Business Intelligence Publisher. |
|
BI_REST_REPORTS_FOLDER |
The location in Oracle Analytics Cloud where Order Management System reports are stored. Should be set to OMSCS/Reports/. |
|
BI_REST_URL |
The name of the host where Oracle Business Intelligence Publisher is running. The system uses this property to build the URL for communication with Oracle Business Intelligence Publisher. For example: https://<host>:<port>/xmlpserver/services/rest/reports where:
|
|
BI_REST_PORT |
The IP port number where Oracle Business Intelligence Publisher is running. The system uses this property to build the URL for communication with Oracle Business Intelligence Publisher. For example: https://<host>:<port>/xmlpserver/services/rest/reports where:
|
|
BI_REST_SERVER_PATH |
The fixed prefix for Oracle Business Intelligence Publisher REST report resource. The system uses this property to build the URL for communication with Oracle Business Intelligence Publisher. For example: https://<host>:<port>/xmlpserver/services/rest/v1/reports where:
|
|
BI_REST_USER |
The user ID used to connect to Oracle Business Intelligence Publisher. |
|
BI_REST_PASSWORD |
The password for the user ID used to connect to Oracle Business Intelligence Publisher. For security, the system encrypts the password. |
Date Format on Reports and Forms
Reports and forms generated using Oracle Business Intelligence Publisher display the date in the date format defined in Oracle Business Intelligence Publisher for the locale in the Company table. Since the only locale supported is English, the date format for reports generated using Oracle Business Intelligence Publisher is always MM/DD/YY.
Reports and forms that are not generated using Oracle Business Intelligence Publisher, display the date in the date format defined for the company.
Note:
Reports that are not associated with a company display the date in the date format defined for the DEFAULT_DATE_FORMAT property.
Decimal and Thousand Separator on Reports and Forms
Reports and forms generated using Oracle Business Intelligence Publisher use the number format defined in Oracle Business Intelligence Publisher for the locale in the Company table. Since the only locale supported is English, the decimal separator is always a period (.) and the thousand separator is always a comma (,).
Reports and forms that are not generated using Oracle Business Intelligence Publisher display numbers using the characters defined in the DECIMAL_SEPARATOR and THOUSAND_SEPARATOR properties.
Specify the Maximum Number of Pick Slips Per Spool File
The PICKS_IN_SPOOL_FILE setting in Working with Admin Properties (CPRP) indicates the maximum number of pick slips in a single PDF document. The system continues to break pick slips into separate PDF documents using the criteria outlined under Sorting Pick Slips into Separate PDF Documents; however, if the number of pick slips in a PDF document reaches the number defined in the PICKS_IN_SPOOL_FILE setting, the system creates a new PDF document.
Note:
The system uses the PICKS_IN_SPOOL_FILE setting when printing pick slips through Streamlined Pick Slip Generation (WSPS) and Reprinting and Voiding Pick Slips (WVRP or WSVP). Also, the system uses this setting when printing Gift Acknowledgements.
Working with the pick slip form: Once the system finishes processing one pick slip PDF document, you can open and print the pick slips in the document using the Forms Management Screen; you do not have to wait until all of the PDF documents for the pick slip generation run have generated.
When printing pick slips, the system includes a PDF document sort number in the name of the document generated for the pick slip. For example, if the system generates two pick slip PDF documents for warehouse 1, ship via priority 5, the system names the documents PICKG.ALINCOLN.20110804.103001456_001.PDF and PICKG.ALINCOLN.20110804.103001456_002.PDF, where PICKG is the name of the print program, ALINCOLN is the user ID of the person who generated the pick slips, 20110804.103001456 is the date and time stamp, and 001 and 002 is the PDF document sort number. See Form Naming Conventions for more information.
Recommended setting: The recommended setting is 250 picks. The system also uses 250 as the default value if this setting is blank in Working with Customer Properties (PROP).
Example: When the PICKS_IN_SPOOL_FILE setting is 600, the system creates the following PDF documents for a pick slip generation run:
-
50 pick slips for warehouse 1, ship via priority 1 (PICKG.ALINCOLN.20110804.103000123_001.PDF)
-
300 pick slips for warehouse 1, ship via priority 5 (PICKG.ALINCOLN.20110804.103001456_001.PDF)
-
510 pick slips for warehouse 1, ship via priority 9 (PICKG.ALINCOLN.20110804.103003789_001.PDF)
-
75 pick slips for warehouse 2, ship via priority 1 (PICKG.ALINCOLN.20110804.103006912_001.PDF)
-
225 pick slips for warehouse 2, ship via priority 5 (PICKG.ALINCOLN.20110804.103007134_001.PDF)
-
25 pick slips for warehouse 2, ship via priority 9 (PICKG.ALINCOLN.20110804.103008112_001.PDF)
When the PICKS_IN_SPOOL_FILE setting is 250, the system creates the following PDF documents for the same pick slip generation run:
-
50 pick slips for warehouse 1, ship via priority 1 (PICKG.ALINCOLN.20110804.103000123_001.PDF)
-
250 pick slips for warehouse 1, ship via priority 5 (PICKG.ALINCOLN.20110804.103001456_001.PDF)
-
50 pick slips for warehouse 1, ship via priority 5 (PICKG.ALINCOLN.20110804.103001456_002.PDF)
-
250 pick slips for warehouse 1, ship via priority 9 (PICKG.ALINCOLN.20110804.103003789_001.PDF)
-
250 pick slips for warehouse 1, ship via priority 9 (PICKG.ALINCOLN.20110804.103003789_002.PDF)
-
10 pick slips for warehouse 1, ship via priority 9 (PICKG.ALINCOLN.20110804.103003789_003.PDF)
-
75 pick slips for warehouse 2, ship via priority 1 (PICKG.ALINCOLN.20110804.103006912_001.PDF)
-
225 pick slips for warehouse 2, ship via priority 5 (PICKG.ALINCOLN.20110804.103007134_001.PDF)
-
25 pick slips for warehouse 2, ship via priority 9 (PICKG.ALINCOLN.20110804.103008112_001.PDF)
Notice that the system creates multiple PDF documents for pick slips in warehouse 1, ship via priority 5 and for pick slips in warehouse 1, ship via priority 9, based on 250 in the PICKS_IN_SPOOL_FILE setting.
Set up Related System Control Values
You need to specify the program name for each form in order to generate the form. See the Forms Summary Table for a listing of forms and the standard print programs for each.
You can also use a unique print program if you require a form laid out differently from the standard. Contact your Order Management System representative if you need to develop a unique print program for a form.
Create Image Files for Company or Entity Logos (Graphical Forms)
Note:
Important: Company and entity logos on forms are not currently implemented.
If you use a standard graphical print program for a form, you can point to an image of your company logo to include on the form. The image must be in JPG format, and you need to set up a separate image for each form in each company. Optionally, you can set up images at the entity logo instead of the company level, which prints on selected forms. See Setting Up Company Logos for Forms for configuration instructions.
Forms Properties
The properties assigned to the Forms group in Working with Customer Properties (PROP) control whether certain information prints on certain forms.
For example, these settings control whether to print a barcode on the pick slip. See Forms Property Settings for more information.
Form Naming Conventions
The system uses the print program, job date and time stamp, and the user ID of the person who generates the forms to name the PDF files.
For example, a file named PURCHORDG.SBROWN.20110214.123456.pdf indicates that the file:
-
contains graphical purchase orders (PURCHORDG)
-
was generated by the user SBROWN
-
was generated on June 30, 2011, at 12:34:56 (20110630.123456)
Additional form naming information: Certain print programs include additional parameters in the naming conventions:
-
Backorder notices: File names for backorder notices indicate which notices are included in the file. For example, a file named BOCARDSSECOND.SBROWN.20110214.123456.pdf contains second notices.
-
Soldout notices: File names for soldout notifications include the three-letter country code for the sold-to customer’s address. For example, a file named SOLDOUTCAN.SBROWN.20110214.123456.pdf contains soldout notifications for sold-to customers who live in Canada.
-
Gift Acknowledgements: The system uses the print program, the user ID of the person who started the background jobs, the job date and time stamp, and the document sort number as the name the gift acknowledgement PDF file. For example, a file named GIFTACKG.SBROWN.20110828.163639681_002.pdf indicates this is a gift acknowledgement PDF document generated by user SBROWN on August 28, 2011 and the document is the second document for a specific gift acknowledgement sort. Note: The user ID of the person who started the background jobs may not be the user ID of the person who generated pick slips or billed the order associated with the gift acknowledgement.
-
Order Receipts: The system uses the print program, the order number and ship-to number (separated by a hyphen), the user ID of the person who generated the receipt, and a date and time stamp. For example, a file named ORDERRECG-10204-1.TBROWN.20110506.164303184.pdf indicates that this is an order receipt generated with the Order Receipt Print Program (L46) set to ORDERRECG, for order 10204, ship-to 1, by user TBROWN, on May 6, 2011, at approximately 4:43 p.m.
-
Pick slips: The system uses the print program, the user ID of the person who generated pick slips, the job date and time stamp, and the document sort number as the name of the pick slip PDF document. For example, a file named PICKG.TBROWN.20110804.103001456_002.PDF indicates this is a pick slip PDF document generated by user TBROWN on August 4, 2011 and the document is the second document for a specific pick sort, such as pick slips for warehouse 1 and ship via priority 5. See Sorting Pick Slips into Separate PDF Documents for more information on how the system breaks pick slips into separate spool files. See Specify the Maximum Number of Pick Slips Per Spool File for more information on how the system determines the maximum number of pick slips in a spool file.
Forms Troubleshooting
Some possible troubleshooting questions and answers are:
| Question | Possible Answer(s) |
|---|---|
|
How is the system determining the date format for dates that display on forms? |
Reports and forms generated using Oracle Business Intelligence Publisher display the date in the date format defined in Oracle Business Intelligence Publisher for the locale in the Company table. Since the only locale supported is English, the date format for reports generated using Oracle Business Intelligence Publisher is always MM/DD/YY. Reports and forms that are not generated using Oracle Business Intelligence Publisher, display the date in the date format defined for the company. Note: Reports that are not associated with a company display the date in the date format defined for the DEFAULT_DATE_FORMAT property. |
|
How is the system determining the decimal and thousand separator for numbers that display on forms? |
Reports and forms generated using Oracle Business Intelligence Publisher use the number format defined in Oracle Business Intelligence Publisher for the locale in the Company table. Since the only locale supported is English, the decimal separator is always a period (.) and the thousand separator is always a comma (,). Reports and forms that are not generated using Oracle Business Intelligence Publisher display numbers using the characters defined in the DECIMAL_SEPARATOR and THOUSAND_SEPARATOR properties. |
|
Why is the system generating a blank (empty) PDF file? |
If there are no records eligible for forms when you submit a job, the system generates a blank (empty) PDF file. This might occur if, for example, you generate backorder cards a second time on the same day; in this situation, the first submitted job generated all eligible backorder cards so the PDF generated the second time is blank. |
|
Are forms automatically deleted? |
Forms older than the JOB_RETENTION_DAYS property in Working with Admin Properties (CPRP) are deleted when you restart Order Management System. |
|
Why are the outer portions of the page cut off when I print a form? |
All other forms: Make sure that the Page scaling option in the Print dialog box is set to Fit to printer margins when printing a form to prevent information on the edge of the page from being cut off. |
|
Why isn’t the company logo printing on the form? |
Confirm that the image has been set up using the correct size, file name, and location, as described under Create Image Files for Company or Entity Logos (Graphical Forms). Also, if you have specified to print the entity logo rather than the company logo, then you must create and name an entity logo for each entity in order for any logo to print on a graphical form that uses the logo. See Setting Up Company Logos for Forms for more information. |
|
How can I verify where the data on the form is coming from? |
The data comes from the related files for the customer, order, vendor, or bill-to account. |
|
Why doesn’t a new window open when I click the name of a form at the Forms Management Screen? |
The system keeps a single additional window open for you to review a form or a report. If you already had a form or report open in the additional window, the system replaces the document previously displayed with the form you have just selected. Reopen the additional window to review the recently selected form. |
Forms Summary Table
You use a system control value to indicate the print program to use for each form type. For each form type, the following table lists each of these system control values and the standard print program(s), and provides links to form samples and descriptions.
| Form | System Control Value | Standard Print Program(s) | Form Description and Sample(s) |
|---|---|---|---|
|
Backorder Cards |
BOCARDS |
||
|
Customer Invoices |
ORDERRECG (graphical) |
||
|
Drop Ship Documents |
PICKG (graphical) |
||
|
Gift Acknowledgements |
GIFTACKG (graphical) |
||
|
Order Receipt |
ORDERRECG (graphical) |
||
|
Pick Documents |
PICKG or PICKDBG (graphical) |
||
|
Pick Label |
PICKLBL |
||
|
Purchase Orders |
PURCHORDG (graphical) |
||
|
Refund Checks |
REFCHECK (non-graphical) REFCHECKG (graphical) |
||
|
Soldout Notices |
SOLDOUT |
||
|
Quotes |
QUOTEG (graphical) QUOTE (non-graphical) |
Forms Management Screen
How to display this screen: Click the My Forms icon
(
in the upper right area of a screen), or select My
Forms from an Admin screen (such as the About Application, Document
Management Screen, Job Management Screen, Commands, User Control, or System Messages screens)
Information on this screen:
-
Form: Click the document icon next to the form to open the form in a separate window. From this window, you can review and print the form, using the standard Windows print options for your PC. Once someone has viewed the form, or the form was automatically sent to a printer, the screen displays an eyeglass icon (
)next to the form name. If you click on this icon, the system
displays a log indicating who viewed the report: Viewed
By: TBROWN on 11/29/2015 10:57:30
Note:
If you already have a separate browser window open to review another form or a report, the system does not open an additional window; instead, the previous form or report is replaced with the recently-selected form.
For more information: See Form Naming Conventions for additional information on form names.
If no forms display on the screen: Forms older than the JOB_RETENTION_DAYS property in Working with Admin Properties (CPRP) are deleted when you restart Order Management System.
Form Listings and Display Options
Default settings for forms available for review: When you first advance to this screen, up to 200 forms submitted by your user ID are currently available for review by scrolling up or down with the right-hand scroll bar. The forms are listed in reverse chronological order (newest to oldest). A message displays if more than 200 records are available for review: The maximum number of records was exceeded. Please refine search criteria. Showing records 1-200.
Available forms updated when you filter: When you enter or select any search criteria and then click OK, the screen displays up to 200 forms that match these criteria.
Example: The screen currently includes 200 forms available for review in reverse chronological order (newest to oldest): 180 of these forms are in the Pick Documents folder, and 20 are in the Drop Ship Documents folder. When you select Pick Documents from the Output folder field and click Filter, the screen displays up to 200 forms in the Pick Documents folder.
Available forms restricted by Rank and All job authority:
-
If the All job authority option is selected for your user control record, you can review all jobs, regardless of ranking.
-
If the All job authority option is not selected for your user control record, you can review forms generated by other users only if their user control Rank does not exceed yours.
Example:
Users JJONES has a Rank of 9, with All job authority selected.
User TBROWN has a Rank of 9, with All job authority unselected.
User BWILLIAMS has a Rank of 1, with All job authority selected.
Result:
-
JJONES can review forms generated by WBLAKE because their Rank is the same; however, JKEATS cannot review forms generated by RBROWNING, because a Rank of 1 exceeds a Rank of 9.
-
TBROWN cannot review forms generated by any other users, because he does not have All job authority.
-
BWILLIAMS can review forms generated by all other users based on his Rank and All job authority.
Note:
Different rules control the authority to view forms and reports than the rules that affect the Job Management Screen. The user’s Rank does not affect authority to view jobs.
Column sort: You can sort on any column by clicking the column heading name. When you first click, the sort is in ascending alphanumeric (A-Z) or numeric (lowest to highest) order. Click again to change the sort to descending (Z-A) or numeric (highest to lowest) order.
| Field | Description |
|---|---|
|
Form |
The name of the file containing the form. See Form Naming Conventions for a discussion. Filter options:
|
|
File size |
The size, in bytes, of the PDF file containing the form. Display-only. |
|
Date |
The date and time when the form was generated. Filter options:
|
|
User name |
The user ID of the person who generated the form. Your user ID defaults. Submitted through web service request? When you use the CWProcessIn message or the ProcessIn message to start a periodic process, the form is listed under the default user set up during installation. Contact your cloud administrator or system administrator to confirm the user ID of the default user, and see Using the CWProcessIn Message to Start a Periodic Process or Using the ProcessIn REST Message to Start a Periodic Process for background. For more information see the Web Services Guide on My Oracle Support (ID 2149144.1) Filter options: to display forms generated by another user: enter a complete, valid user ID and click OK. to display forms regardless of the user who generated them: clear the current entry in this field and click OK. |
Form Management Screen Options
| Option | Procedure |
|---|---|
|
Review, and optionally print, a generated form |
Click the document icon next to the file name to open the form in a separate window. From this window, you can print the form using the standard Windows options and printers currently available to your local PC. Note: The system keeps a single additional window open for you to review a form or a report. If you already had a form or report open in the additional window, the system replaces the document previously displayed with the form you have just selected. Reopen the additional window to review the recently selected form. |
|
Change which forms are displayed on the screen |
|
|
Restrict or expand the list of displayed forms based on one of the available column headings |
See the Form Listings and Display Options for information on how to filter the forms displayed based on various criteria. |
|
Refresh data listed on the screen |
Click Refresh. Newly generated forms are added to the screen as they are generated. |
|
Sort by column |
Click the column heading name. When you first click, the sort is in ascending alphanumeric (A-Z) or numeric (lowest to highest) order. Click again to change the sort to descending (Z-A) or numeric (highest to lowest) order. |
|
Delete an individual form |
Select the checkbox to the left of a form and click Delete. |
|
Display additional information about a form or advance to a different screen |
If you advance to a different screen and then return, your filter entries are not retained. For example, if you are currently filtering on a specific output folder, and you advance to the Job Management (My Jobs) screen and return, the Output folder column no longer filters on that folder. |
|
Display information about Order Management System |
Select About. |
|
Advance to the Document Management Screen screen |
Select My Docs. |
|
Advance to the Job Management Screen |
Select My Jobs. |
|
Advance to the Advanced Commands screen |
Select Advanced commands. This option is available only for users that have authority to the Advanced Commands option. |
|
Return to the previous screen |
Select Exit. |
Job Management (My Jobs)
Purpose: Use the Job Management screen to work with submitted jobs that have been processed, are currently processing, or are waiting to be processed. The jobs listed at this screen include each interactive session for the user.
This topic also discusses options you can use to review the jobs currently running and correct a job’s status if it is inconsistent.
In this topic:
For more information: See:
Job Management Screen
How to display this screen: Click the My Jobs icon (
) in
the upper right area of a screen), or select My Jobs from
an Admin screen (such as the About
Application, Forms Management Screen, Document Management Screen, Commands, User Control, or System Messages screens). When you advance to the screen this way, it displays all jobs generated through your user ID. See the field descriptions and screen options below for information on how to filter the jobs listed on this screen.
Column sort: You can sort on any column by clicking the column heading name. When you first click, the sort is in ascending alphanumeric (A-Z) or numeric (lowest to highest) order. Click again to change the sort to descending (Z-A) or numeric (highest to lowest) order.
Information on this screen:
| Field | Description |
|---|---|
|
Output Queue |
Provides the option for you to switch the job queue where one or more jobs should run. The system-delivered job queues are:
|
|
<- Route Job |
Use this button to route a job to the queue selected in the Queue field, described above:
You can select a different route only if the job has not yet started to run (RDY status). |
|
Job Listings |
Default settings for jobs available for review: When you first advance to this screen, up to 200 jobs submitted by your user ID are currently available for review by scrolling up or down with the right-hand scroll bar. The jobs are listed in reverse chronological order (newest to oldest). A message displays if more that 200 jobs are available for review: The maximum number of records was exceeded. Please refine search criteria. Showing records 1-200. Available jobs updated when you filter: When you enter or select any search criteria and then click Filter, the screen displays up to 200 jobs that match these criteria. Example: The screen currently includes 200 jobs available for review in reverse chronological order (newest to oldest): 180 of these jobs run in QBATCH, and 20 run in ASYNC. When you select QBATCH from the Queue field and click OK, the screen displays up to 200 jobs that run in QBATCH. Available jobs restricted: If your user control record does not have All job authority selected, you cannot review jobs submitted by other users. Example: If you do not have All job authority, when you filter on a Job name of PICK_GEN, pick slip generation jobs submitted by other users are not displayed. |
|
Action |
An arrow in this field indicates an action can be performed against the job. Valid actions are:
See the Job Management Screen Options. |
|
User name |
The user name of the person who submitted the job, or who is using an interactive session. Defaults to your user ID. Submitted through web service request? When you use the CWProcessIn message or the ProcessIn message to start a periodic process, if the message did not indicate to wait for completion, the job is listed under the default user set up during installation; otherwise, if the message indicated to wait for completion, the job is not listed on this screen. Contact your cloud administrator or system administrator to confirm the user ID of the default user, and see Using the CWProcessIn Message to Start a Periodic Process or Using the ProcessIn REST Message to Start a Periodic Process for background. For more information see the Web Services Guide on My Oracle Support (ID 2149144.1) Filter options: The following options are available only for users whose All Job Authority setting is selected:
See the Administration guide for more information on setting up users. |
|
Job name |
A code identifying the job. The job name for an interactive session has a name starting with QPADEV (for example, QPADEV0B9A). Defaults to blank. Note: The reports icon ( Filter options:
No report? If there was no information matching the selection
criteria for the report, the system may not generate a blank report;
instead, you see the reports icon ( |
|
Job |
A system-assigned identification number to track the job. Defaults to blank. |
|
Status |
The current status of the job. Defaults to all jobs regardless of status. Possible statuses are:
|
|
|
Integration layer jobs Jobs you start through the Working with Integration Layer Processes (IJCT) option might not display the current, correct status if they receive inbound messages and have not yet received any messages to process. |
|
|
Async jobs When the async jobs in the Background Job Control (MBJC) menu option are active, the system periodically checks the status of each async job, and changes the status to Run, if necessary. For example, if the ORDR_ASYNC job is active and you end it at this screen, the system automatically changes the status of the job back to Run. To start or stop the async jobs, use the Background Job Control (MBJC) menu option. See Working with the CNTL_ASYNC Job. Filter options:
|
|
Started |
The date and time when the job started. Defaults to blank. NONE indicates the job has not yet finished (the status is Ready, Hold, or Run). Filter options:
|
|
Ended |
The date and time when the job finished. Defaults to blank. NONE indicates the job has not yet finished (the status is Ready, Hold, or Run). Filter options:
|
|
Runtime |
The amount of time, in seconds, that the job took to run. Set to 0 if the job has not yet completed. Display-only. |
|
Output Queue |
The job queue where the job will run, is running, or ran. Defaults to blank. See the Output Queue field above for a listing of system-delivered queues. Filter options:
|
|
Log |
A link to a brief log file for the job; available if the job has finished running and your user ID is assigned to Rank 1. This log provides just a list of the programs called in order to complete the job. See Logs for additional logs you can use for troubleshooting. |
Job Management Screen Options
| Option | Procedure |
|---|---|
|
Restrict or expand the list of displayed jobs based on one of the available column headings |
See the Job Listings for information on how to filter the jobs displayed based on various criteria. |
|
Refresh data listed on the screen |
Click Refresh. Newly submitted jobs are added to the screen in RDY status as they are submitted, and the status of existing jobs is updated. |
|
Sort by column |
Click the column heading name. When you first click, the sort is in ascending alphanumeric (A-Z) or numeric (lowest to highest) order. Click again to change the sort to descending (Z-A) or numeric (highest to lowest) order. |
|
Change a job’s status or queue |
|
|
Hold a job |
If the job has not yet processed (its status is Ready), you can hold it by selecting Hold in the Action field for the job. |
|
Release a job |
If the job is currently held (its status is Hold), you can release it by selecting Release in the Action field for the job. |
|
End a job that is currently running |
If the job’s status is Message, you can end the job by selecting End in the Action field for the job. A window opens if you have selected to end an active job: Warning! You have chosen to end one or more active jobs. PRESS OK TO END JOB, or PRESS CANCEL TO LEAVE JOB RUNNING. At this window, select OK to end the job and update its status to End. If a job is currently running but you suspect that the job is not running normally, use the JOBCLN periodic function. See Using the JOBCLN Function to Resolve Job Status Across Servers for more information. Note: Sometimes when you select to end a job, the job does not end and remains running. In this case, you can use the JOBCLN periodic function. |
|
Delete an individual job |
If the job’s status is Ready, Hold, Finished, Error, or End, and is not actually running, you can delete the job by selecting Delete in the Action field for the job. Note: Deleting a job also automatically deletes all generated reports for that job that would also be available under the Document Management (My Docs) screen; however, it does not delete forms that are available at the Forms Management (My Forms) screen. |
|
Delete selected jobs |
Select the check box to the left of each job you wish to delete and select Delete at the top of the screen. Note:
|
|
Route one or more jobs to a different queue |
If the job is currently ready for processing (its status is Ready) or is hold (its status is Hold) you can route it to a different queue by:
Why route? You might want to route a job to a different queue to expedite processing (for example, if another job is currently running in the job’s default queue, and the queue is single-threaded, meaning that only one job at a time can run in that queue at a time). |
|
Display additional information about a job or advance to a different screen |
Note: If you advance to a different screen and then return, your filter entries are not retained. For example, if you are currently filtering on a specific queue, and you advance to the Document Management (My Docs) screen and return, the Queue column no longer filters on that queue. |
|
Review the log for a job |
Click Log file for a job to display its log. Note: A User Rank of 1 is required in order for the user to display the contents in log contents, including the logs written for the user’s own submitted jobs. Otherwise, the window displays a message: Not Available. |
|
Display the server where a user is logged in, or display the command used to execute a job |
Move your cursor over the Action icon to the left of the job entry. The Command field displays:
|
|
Review, and optionally print, reports generated by a job |
Click the
reports icon ( Note: Forms, such as pick slips, purchase orders, or checks, are available from the Forms Management Screen rather than the Document Management Screen. |
|
Display information about Order Management System |
Select About. |
|
Advance to the Forms Management Screen |
Select My Forms. |
|
Advance to the Document Management Screen |
Select My Docs. |
|
Advance to the Advanced Commands screen. |
Select Advanced commands. This option is available only for users that have authority to the Advanced Commands option. |
|
Return to the previous Order Management System screen |
Select Exit. |
Jobs Troubleshooting
| Question | Possible Answer(s) |
|---|---|
|
Why are the background async jobs not starting correctly? |
|
|
Why can’t I change the status of an async job? |
When the async jobs in the Background Job Control (MBJC) menu option are active, the system periodically checks the status of each async job, and changes the status to RUN, if necessary. For example, if the ORDR_ASYNC job is active and you end it at this screen, the system automatically changes the status of the job back to RUN. To start or stop the async jobs, use the Background Job Control (MBJC) menu option. See Working with the CNTL_ASYNC Job. Also, to correct jobs whose statuses are incorrect, use the JOBCLN periodic function. See Using the JOBCLN Function to Resolve Job Status Across Servers for more information. |
|
Why do I receive the error Function key not allowed when I press F5 to refresh the Job Management screen? |
To refresh the Job Management screen, click Refresh. |
|
Why does a submitted job go into Message status? |
Typically, this occurs because someone has stopped and restarted Order Management System. In this case, use the JOBCLN periodic function to resolve. If this is not the reason, check the following logs to determine other possible reasons, looking for messages that were written to the log at the time when the job went into Message status. For example, an error such as out of memory, program not found, or null pointer might help you determine the cause of the problem. The jobs and the activities they track are:
To Reset the Job Status Use the Display Active Batch Jobs Screen to determine if the job is actively running. To fix: If the job status is inconsistent, run the JOBCLN periodic function. See Using the JOBCLN Function to Resolve Job Status Across Servers for more information. |
|
Are job entries automatically deleted? |
Jobs older than the JOB_RETENTION_DAYS property in Working with Admin Properties (CPRP) are deleted when you restart Order Management System. |
|
How can I delete a job if it’s not actually running, regardless of the displayed status? |
If the screen displays an error message when you attempt to delete a job, but the job is not actually running, use the JOBCLN function, as described above. |
|
After I deleted all of the documents for a submitted job, why does the job remain on the My Jobs screen? |
Deleting all of the output for a submitted job does not delete the submitted job. You need to use the Remove option to remove the job. Note: You should remove a submitted job if it is in finished (FIN) status. Evaluate the status of a job that is in an error (ERR) or message (MSG) status before removing it. |
|
Does deleting a job entry delete its associated documents? |
Deleting a job entry automatically deletes all generated reports for that job that would also be available under the Document Management (My Docs) screen; however, it does not delete forms that are available at the Forms Management (My Forms) screen. |
|
How can I review all of the jobs for a particular job queue? |
On the Job Management screen, clear the User Name field, select the job queue from the Queue drop down box and click Filter. Note: This option is available only if you have the required authority based on your user control record. Contact your Order Management System representative if you need information on configuring user control records. |
|
Why can’t I see jobs submitted by all users? |
If your user control record does not have All job authority selected, you cannot review jobs submitted by other users. Contact your Order Management System representative if you need information on configuring user control records. |
|
Can I choose the job queue the system uses to process a job? |
When a job is first submitted to the job queue, the system automatically chooses which job queue to use to process the job, based on the type of job submitted. However, if the job has not yet processed (its status is Ready), you can route it to a different job queue by:
This option is useful if, for example, a large job is currently active in QBATCH, and you would like to run a report job in a separate job queue so it will process quickly. |
|
How can I review and query batch jobs that have run? |
Reviewing Job History The Display Job History (DJHY) screen displays the Job History table. You can review the data and search by server, date range, job queue, and/or job name. The Job History table in the Order Management System database lists batch jobs that have run, including batch jobs that have been removed from the Job Management Screen. These records remain in this table up to the specified purge days. The fields in this table are:
Purging Records in the Job History Table The JOB_HISTORY_PURGE_ DAYS setting in Working with Admin Properties (CPRP) defines how long to retain a batch job in the Job History table before the system purges it automatically based on the job’s End date. The default setting is 30 days. The system submits the Job History purge process each time you start the application server. Job History records that do not have an End Date (indicating the job did not end) are not purged. |
|
Why can’t I see the contents of the log for a job I submitted? |
A User Rank of 1 is required in order to display the contents in the Log column, including the logs written for your own submitted jobs. Otherwise, the window displays a message: Not Available. |