AppWorx Documentation Standards
- Julie Schneider
- Marcella Thompson (Deactivated)
Overview
AppWorx Job documentation gives an overview of the Job's purpose, steps, and other technical information. AppWorx Documentation Standards provide documentation uniformity for developers.
Job Level
Item | Contents | Sample or Standard Text |
|---|---|---|
| Job Name | Same as the Top Level Chain Name without "_C" | BUD_OB_HUB_LOAD |
| Project Name | BOG Master Files Conversion | |
| Project Number | | Ex: 07-0165 |
| Job Description | For all jobs, description of what job does | This job is used to load OB (Operating Budget) information in the Data Warehouse under the DATA_HUB schema. For jobs that also load BOG tables, add this: |
| | For all jobs, list of tables loaded | Example for HUB job: |
| | For all jobs, statement regarding STATS and DQ Reports | Statistics and OB Data Quality (DQ) reports are created and delivered via email in PDF format. Use DocMart "Report Subscription" to receive the Statistics and specific DQ reports. |
| | For BOG jobs only, statement regarding submission frequency | This information is used to create the SIFP files that are submitted to the BOG each Spring and Fall. |
| | For BOG jobs only, list of files created | The following files are created on the secured server in the SIFP folder: Pperson_Demo Pperson_ID_Chgs (as required) Eenrollments Alternative: The following files are created on the secured server in the OB folder: OB-<runid>-UNIV_DEPT_MASTER.txt OB-<runid>--OPERATING_BUDGET.txt |
| Job Comments | Parameters that require an explanation | Review and, if necessary, change the following parameters: Time Frame (default Current Term) File submission processing term Fee Waivers E and G (default 0) Use to transfer waiver E&G waiver amounts from 'B' to 'O'. Enter current budget year E&G amount Fee Waivers HSC (default 0) Use to transfer waiver HSC waiver amounts from 'B' to 'O' Enter current budget year HSC amount |
| User Group | Should match highest qualifier of job name | For job name: BUD_OB_HUB_LOAD, User Group would be BUD |
| Application | | DWHOUSE |
| Functional Project Manager | | Carrie Garcia |
| Business Analyst | BA assigned to the submission | |
| IT Project Manager | | DWHOUSE: Carrie Garcia OASIS: Carrie Garcia ABS: Patrick McClain |
| User/Stakeholder | Contact Data Steward for submission | If Data Steward is not in drop-down list, contact the Administrator in your area. |
| URL | Link to Process Flow Diagram PDF | http://reports.admin.usf.edu:8001/DW/BOG/[name of pdf file] Note: Contact Julie Schneider to add PDF file to above folder (if necessary) |
| Click Here link | Use to verify PDF hyperlink | |
Update Web Documentation button | Use to update documentation immediately | Note: Documentation is automatically updated every Sunday; however, button can be used to update immediately |
IT Analytics, SVC4010, Contact Us