Package: Dokumentation Erzeugen

Dieses Modul kann Dokumentationen für die Objekte eines Package erzeugen. Als Basis für die Dokumentation dienen Vorlagen, die für jeden zu dokumentierenden Objekttyp erstellt werden können. Das Textformat der Vorlagen kann frei gewählt werden. Beispiele für mögliche Ausgabeformate sind HTML, Confluence Storage Format, Markdown oder SVG.

Bezeichnung

Name

pm.DocBuilder

Aliase

DocumentationGenerate, pm.DocumentationGenerate, pm.PackageDocumentationGenerate

Konfiguration

Optionen

Package (package)

Name des Package

Vorlagenverzeichnis (template-dir)

Verzeichnis in dem die Vorlagen liegen

Vorlagen-Variable (template-vara)

Eine statische Variable, die den Objekttyp mit einem Objekt zusammenführt, dass die Dokumentation für diesen enthält.

Verbindung (template-source)

Ist diese gesetzt, dann wird die Vorlagen-Variable in der Verbindung gesucht. Anderenfalls wird sie in der Standard-Verbindung gelesen.Mögliche Werte: <TabItem b4A Verbindungen>

Ausgabeverzeichnis (output-dir)

Die erzeugte Dokumentation wird in dem Verzeichnis gespeichert

Ausgabe-Variable (output-vara)

Die erzeugte Dokumentation wird in einer statischen Variable gespeichert

Ausgabe Zeichenkodierung (output-encoding)

Zeichenkodierung für die Ausgabedateien. Ist keines angegeben, dann wird das Standard Encoding der JVM verwendet.Mögliche Werte: Big5 (Big5), Big5-HKSCS (Big5-HKSCS), CESU-8 (CESU-8), EUC-JP (EUC-JP), EUC-KR (EUC-KR), GB18030 (GB18030), GB2312 (GB2312), GBK (GBK), IBM-Thai (IBM-Thai), IBM00858 (IBM00858), IBM01140 (IBM01140), IBM01141 (IBM01141), IBM01142 (IBM01142), IBM01143 (IBM01143), IBM01144 (IBM01144), IBM01145 (IBM01145), IBM01146 (IBM01146), IBM01147 (IBM01147), IBM01148 (IBM01148), IBM01149 (IBM01149), IBM037 (IBM037), IBM1026 (IBM1026), IBM1047 (IBM1047), IBM273 (IBM273), IBM277 (IBM277), IBM278 (IBM278), IBM280 (IBM280), IBM284 (IBM284), IBM285 (IBM285), IBM290 (IBM290), IBM297 (IBM297), IBM420 (IBM420), IBM424 (IBM424), IBM437 (IBM437), IBM500 (IBM500), IBM775 (IBM775), IBM850 (IBM850), IBM852 (IBM852), IBM855 (IBM855), IBM857 (IBM857), IBM860 (IBM860), IBM861 (IBM861), IBM862 (IBM862), IBM863 (IBM863), IBM864 (IBM864), IBM865 (IBM865), IBM866 (IBM866), IBM868 (IBM868), IBM869 (IBM869), IBM870 (IBM870), IBM871 (IBM871), IBM918 (IBM918), ISO-2022-CN (ISO-2022-CN), ISO-2022-JP (ISO-2022-JP), ISO-2022-JP-2 (ISO-2022-JP-2), ISO-2022-KR (ISO-2022-KR), ISO-8859-1 (ISO-8859-1), ISO-8859-13 (ISO-8859-13), ISO-8859-15 (ISO-8859-15), ISO-8859-16 (ISO-8859-16), ISO-8859-2 (ISO-8859-2), ISO-8859-3 (ISO-8859-3), ISO-8859-4 (ISO-8859-4), ISO-8859-5 (ISO-8859-5), ISO-8859-6 (ISO-8859-6), ISO-8859-7 (ISO-8859-7), ISO-8859-8 (ISO-8859-8), ISO-8859-9 (ISO-8859-9), JIS_X0201 (JIS_X0201), JIS_X0212-1990 (JIS_X0212-1990), KOI8-R (KOI8-R), KOI8-U (KOI8-U), Shift_JIS (Shift_JIS), TIS-620 (TIS-620), US-ASCII (US-ASCII), UTF-16 (UTF-16), UTF-16BE (UTF-16BE), UTF-16LE (UTF-16LE), UTF-32 (UTF-32), UTF-32BE (UTF-32BE), UTF-32LE (UTF-32LE), UTF-8 (UTF-8), windows-1250 (windows-1250), windows-1251 (windows-1251), windows-1252 (windows-1252), windows-1253 (windows-1253), windows-1254 (windows-1254), windows-1255 (windows-1255), windows-1256 (windows-1256), windows-1257 (windows-1257), windows-1258 (windows-1258), windows-31j (windows-31j), x-Big5-HKSCS-2001 (x-Big5-HKSCS-2001), x-Big5-Solaris (x-Big5-Solaris), x-euc-jp-linux (x-euc-jp-linux), x-EUC-TW (x-EUC-TW), x-eucJP-Open (x-eucJP-Open), x-IBM1006 (x-IBM1006), x-IBM1025 (x-IBM1025), x-IBM1046 (x-IBM1046), x-IBM1097 (x-IBM1097), x-IBM1098 (x-IBM1098), x-IBM1112 (x-IBM1112), x-IBM1122 (x-IBM1122), x-IBM1123 (x-IBM1123), x-IBM1124 (x-IBM1124), x-IBM1129 (x-IBM1129), x-IBM1166 (x-IBM1166), x-IBM1364 (x-IBM1364), x-IBM1381 (x-IBM1381), x-IBM1383 (x-IBM1383), x-IBM29626C (x-IBM29626C), x-IBM300 (x-IBM300), x-IBM33722 (x-IBM33722), x-IBM737 (x-IBM737), x-IBM833 (x-IBM833), x-IBM834 (x-IBM834), x-IBM856 (x-IBM856), x-IBM874 (x-IBM874), x-IBM875 (x-IBM875), x-IBM921 (x-IBM921), x-IBM922 (x-IBM922), x-IBM930 (x-IBM930), x-IBM933 (x-IBM933), x-IBM935 (x-IBM935), x-IBM937 (x-IBM937), x-IBM939 (x-IBM939), x-IBM942 (x-IBM942), x-IBM942C (x-IBM942C), x-IBM943 (x-IBM943), x-IBM943C (x-IBM943C), x-IBM948 (x-IBM948), x-IBM949 (x-IBM949), x-IBM949C (x-IBM949C), x-IBM950 (x-IBM950), x-IBM964 (x-IBM964), x-IBM970 (x-IBM970), x-ISCII91 (x-ISCII91), x-ISO-2022-CN-CNS (x-ISO-2022-CN-CNS), x-ISO-2022-CN-GB (x-ISO-2022-CN-GB), x-iso-8859-11 (x-iso-8859-11), x-JIS0208 (x-JIS0208), x-JISAutoDetect (x-JISAutoDetect), x-Johab (x-Johab), x-MacArabic (x-MacArabic), x-MacCentralEurope (x-MacCentralEurope), x-MacCroatian (x-MacCroatian), x-MacCyrillic (x-MacCyrillic), x-MacDingbat (x-MacDingbat), x-MacGreek (x-MacGreek), x-MacHebrew (x-MacHebrew), x-MacIceland (x-MacIceland), x-MacRoman (x-MacRoman), x-MacRomania (x-MacRomania), x-MacSymbol (x-MacSymbol), x-MacThai (x-MacThai), x-MacTurkish (x-MacTurkish), x-MacUkraine (x-MacUkraine), x-MS932_0213 (x-MS932_0213), x-MS950-HKSCS (x-MS950-HKSCS), x-MS950-HKSCS-XP (x-MS950-HKSCS-XP), x-mswin-936 (x-mswin-936), x-PCK (x-PCK), x-SJIS_0213 (x-SJIS_0213), x-UTF-16LE-BOM (x-UTF-16LE-BOM), X-UTF-32BE-BOM (X-UTF-32BE-BOM), X-UTF-32LE-BOM (X-UTF-32LE-BOM), x-windows-50220 (x-windows-50220), x-windows-50221 (x-windows-50221), x-windows-874 (x-windows-874), x-windows-949 (x-windows-949), x-windows-950 (x-windows-950), x-windows-iso2022jp (x-windows-iso2022jp)

Suche nach der Verwendung von startbaren Objekten und Workflow-Aufgaben (extended-usage)

Sucht nach der Verwendung von startbaren Objekten und Workflow-Aufgaben und stellt eine Liste der Referenzen auf die Objekte zur Verfügung.

Ebene der Verwendungssuche (extended-usage-level)

Ebene der Verwendungssuche, welche auf Package-Objekte und/oder Workflow-Aufgaben gesetzt werden kann.Mögliche Werte: Objekte und Workflow-Aufgaben (objects-and-tasks), Nur Objekte (objects-only)

Suche nach der Verwendung von startbaren Objekten und Workflow-Aufgaben (inklusive Scripten) (extended-usage-with-processes)

Sucht nach der Verwendung von startbaren Objekten und Workflow-Aufgaben und stellt eine Liste der Referenzen auf die Objekte zur Verfügung. Referenzen in Scripten werden ebenfalls berücksichtigt.

Erweiterte Workflow-Attribute (extended-workflow-attrs)

Aktiviert einen erweiterten Satz von Workflow-Attributen. Für jede Aufgabe des Workflows werden alle Attribute des dazugehörigen Objektes zur Verfügung gestellt. Die Namen der Attribute sind die gleichen wie bei den Objekte mit der zusätzlichen Präfix 'object.'

Erweiterte PromptSet Attribute (extended-promptset-attrs)

Wenn gesetzt, dann werden weitere Details zu den PromptSet-Feldern bereitgestellt

Ersetze b4A Expressions in der Text-Dokumentation (b4a-expression-docu)

Ist die Option gesetzt, dann werden b4A Expressions in der Text-Dokumentation der Objekte ersetzt

Konvertiere in eine JSON Zeichenkette (convert-to-json-string)

Die Option erzwingt die Konvertierung der Ausgabe in einen JSON kompatiblen String

Benutzerdefinierte Attribute (Datei) (custom-attributes-file)

Eine CSV-Datei, die eine Liste von benutzerdefinierten Attributen enthält, die beim Bau der Dokumentation zur Verfügung stehen sollen

Benutzerdefinierte Attribute (custom-attributes)

Eine Liste von benutzerdefinierten b4A Expression Attributen. Jeder Eintrag wird als Schlüssel-Wert-Paar definiert.

Index-Vorlage (index-template-name)

Definiert den Namen der Vorlage für den Package-Index

Eingabe

Objekt-Typen (types)

Für Objekte dieser Typen wird die Dokumentation erzeugtMögliche Werte: Kalender (CALE), Benachrichtigung (CALL), RA-Solution (CITC), Code-Tabelle (CODE), Verbindung (CONN), Cockpit (CPIT), Dashboard (DASH), Dokumentation (DOCU), Ereignis (EVNT), Filter (FILTER), Host-Gruppe (HOSTG), Agent/Mandanten-Zuordnung (HSTA), Dateitransfer (JOBF), Jobgruppe (JOBG), Include (JOBI), Job (JOBS), Workflow (JOBP), RemoteTaskManager (JOBQ), Verknüpfung (LINK), Login (LOGIN), Schedule (JSCH), Script (SCRI), Synchronisation (SYNC), Zeitzone (TZ), Benutzer (USER), Gruppe (USRG), Variable (VARA), Stylesheet (XSL), PromptSet (PRPT), Queue (QUEUE), Storage (STORE), Service Level Objective (SLO), Periode (PERIOD)

Objekt-Typen (types)

Für Objekte dieser Typen wird die Dokumentation erzeugtMögliche Werte: Kalender (CALE), Benachrichtigung (CALL), RA-Solution (CITC), Code-Tabelle (CODE), Verbindung (CONN), Cockpit (CPIT), Dashboard (DASH), Dokumentation (DOCU), Ereignis (EVNT), Filter (FILTER), Host-Gruppe (HOSTG), Agent/Mandanten-Zuordnung (HSTA), Dateitransfer (JOBF), Jobgruppe (JOBG), Include (JOBI), Job (JOBS), Workflow (JOBP), RemoteTaskManager (JOBQ), Verknüpfung (LINK), Login (LOGIN), Schedule (JSCH), Script (SCRI), Synchronisation (SYNC), Zeitzone (TZ), Benutzer (USER), Gruppe (USRG), Variable (VARA), Stylesheet (XSL), PromptSet (PRPT), Queue (QUEUE), Storage (STORE), Service Level Objective (SLO), Periode (PERIOD)

Objektnamenmuster (name)

Die Objektnamen müssen dem Muster entsprechen, ansonsten wird keine Dokumentation erzeugt

Unterordner (sub-folder)

Eine Liste von Unterordnern. Objekte müssen sich in den Unterordnern befinden, ansonsten wird keine Dokumentation erzeugt. Wenn die Liste leer, dann wird in dem gesamten Package-Ordner nach Objekten gesucht.

Beschreibung

Um die Werte der zu dokumentierenden Objekte in den Vorlagen einzufügen werden b4A Expressions genutzt. Dabei können einfache Ersetzungen sowie Funktionen genutzt werden (Details).

Die Vorlagen für die Dokumentation können entweder in Dateien abgelegt werden oder in Dokumentation-Objekten gespeichert werden. Wenn Dateien verwendet werden, dann müssen diese einem Namensschema folgen. Die Endung jeder Vorlagendatei kann beliebig gewählt werden und wird an die Ausgabedatei wieder angehängt, wenn die Ausgabe in Dateien erfolgt. Der Rest des Namens muss einem Objekttyp entsprechen (Beispiel: JOBS.html). Bei Objekttypen mit Untertypen können zusätzlich Vorlagen für die Untertypen angelegt werden (Beispiel: JOBS_UNIX.html). Nur in solchen Vorlagen können die zusätzlichen Attribute für die Subtypen genutzt werden. Für RA-Jobs gibt es eine Variante. Hier kann statt dem Subtyp auch der RA-Typ genutzt werden (Beispiel: JOBS_WEBSERVICEREST.html).

Da viele Objekttypen gleiche Attribute haben und es bei der Nutzung von einigen Formaten immer wieder die gleichen Anfänge und Enden der Vorlagen gibt wird durch das Modul die Möglichkeit bereitgestellt zusätzliche Vorlagen für die Köpfe und Enden der Dokumente zur Verfügung zu stellen. Die Vorlage für den Kopf muss #HEADER heißen und die für das Ende #FOOTER. Werden die Vorlagen als Dateien bereitgestellt werden, so können die Dateinamen ebenfalls eine beliebige Endung haben (z.B. #HEADER.html).

Optional können noch gesonderte Köpfe und Enden für ausführbare Objekte bereitgestellt werden. Diese müssen #HEADER_RUNNABLE und #FOOTER_RUNNABLE heißen. Sind diese nicht vorhanden, dann werden die anderen Vorlagen genutzt. Ist keine dieser besonderen Vorlagen vorhanden, dann muss der gesamte Inhalt für die zu erzeugenden Dokumente in den Objekttyp-Vorlagen enthalten sein.

Ausgabe & Kodierung

Die erzeugte Dokumentation kann in Dateien geschrieben werden. Dafür wird ein Ausgabeverzeichnis angegeben in dem pro Objekt eine Datei angelegt wird. Üblicherweise werden die Ausgabedateien mit der Zeichenkodierung der JVM angelegt. Bei Windows ist dies normalerweise windows-1252, bei Unix UTF-8. In manchen Fällen kann es nötig sein, dass die Dateien zur besseren Weiterverarbeitung eine andere Zeichenkodierung erhalten. Daher kann die Zeichenkodierung in dem Modul frei gewählt werden. Zur Auswahl stehen alle Zeichensätze, die die jeweilige Java Installation kennt. Mindestens jedoch US-ASCII, ISO-8859-1, UTF-8, UTF-16BE, UTF-16LE und UTF-16. Des Weiteren kann die Ausgabe auch in ein statisches Variable-Objekt erfolgen. In dem Fall ist der Key der Objektname und der erste Wert enthält die erzeugte Dokumentation.

Verwendung von Groovy in Vorlagen

Die b4A Expressions unterstützen mit der SCRIPT-Funktion die Programmiersprache Groovy. Wird diese im Kontext des Moduls pm.DocBuilder genutzt, dann gibt es eine Erweiterung. Wenn die Vorlagen für die Dokumentation in einem Verzeichnis liegen, dann gibt es die Möglichkeit in einem Unterverzeichnis Groovy-Klassen abzulegen und diese zu importieren. Dies sorgt bei komplexieren Vorlagen für eine bessere Strukturierung.

Verzeichnisbaum

Vorlagenverzeichnis (Option *template-dir*)
├── JOBP.svg
├── ...
└── lib
    ├── ...
    └── Test.groovy

Test.groovy

 package lib

    class Test {
        def hello() {
            return "hello b4A"
        }
    }

JOBP.svg

    %{SCRIPT:groovy:
    import lib.Test

    def test = new Test()

    $output.append( test.hello() )

Attribute

Eine zusätzliche Vorlage mit dem Namen INDEX kann optional definiert werden. Diese kann genutzt werden um einen Überblick zu dem Package zu generieren. Bei der Generierung auf Basis dieser Vorlage stehen folgende Attribute zur Verfügung.

• package_name

• package_version

• package_description

• package_basefolder

• package_dependencies

• package_dependency_list (Liste)

  • package
  • operator
  • version

• package_metadata (Liste)

  • key
  • value

• package_documentation

• package_release_notes

• ae_system

• ae_client

• b4a_connection

• objects (Liste)

  • name
  • title
  • type
  • subtype
  • folder
  • documented

Bei der Verwendung von Dokumentation-Objekten muss zusätzlich ein Variablen-Objekt verwendetet werden, das einen Index enthält. Der Key ist der Objekttyp und im ersten Wert wird der Name des Dokumentation-Objekts eingetragen. In den Dokumentation-Objekten muss auf dem ersten Text-Dokumentationsreiter der Text der Vorlage eingetragen sein.

Im Folgenden wird zu den Objekttypen die Liste der definierten Attribute aufgelistet. Bei Attributen, die Listen enthalten wird dies entsprechend vermerkt und die Attribute pro Element angegeben.

Alle Objekte

• package_name

• package_version

• package_description

• package_basefolder

• package_folder

• package_dependencies

• package_dependency_list (Liste)

  • package
  • operator
  • version

• package_metadata (Liste)

  • key
  • value

• ae_system

• ae_client

• b4a_connection

• object_name

• object_type

• object_subtype

• object_folder

• title

• archive_key1

• archive_key2

• last_modified

• last_used

• created

• text_docu

• xml_docu

• Die einzelnen Elemente der XML-Dokumentation werden ebenfalls als Attribute zur Verfügung gestellt. Die Namen der Attribute werden aus dem XML-Pfad generiert. Wenn der Reiter der XML-Dokumentation 'Details' heißt und es unterhalb des Elements Content ein Element Link gibt, dann würde das Attribut Details_Content_Link heißen. Zusätzlich würde es das Attribut Details_Content_Link_attributes geben, dass eine Liste der XML-Attribute enthält.

  • <XML-Element>

  • <XML-Element>_attributes (Liste)

    • name
    • value

Alle startbaren Objekte

• active

• custom_attributes (Liste)

  • name
  • value

• int_account

• queue

• start_type

• generate_at_runtime

• priority

• timezone

• max_parallel_tasks

• max_parallel_mode (CANCEL, WAIT)

• sync_list (Liste)

  • sync_object
  • start
  • abend
  • end
  • else

• runtime_execute

• runtime_cancel

• runtime_retcode

• runtime_retcode_execute

• runtime_ert_method (DYNAMIC_ADAPTIVE, DYNAMIC_AVERAGE, DYNAMIC_LINEAR, DYNAMIC_MAX, DEFAULT, FIXED_VALUE)

• runtime_ert_current_seconds

• runtime_ert_current_timestamp

• runtime_ert_fixed_value_seconds

• runtime_ert_fixed_value_timestamp

• runtime_ert_number_of_past_runs

• runtime_ert_correction_percent

• runtime_ert_deviation

• runtime_ert_deviation_min_runs

• runtime_ert_deviation_extent_percent

• runtime_mrt_method (DATE, ERT, FIXED, NONE)

• runtime_mrt_date_days

• runtime_mrt_date_time

• runtime_mrt_date_timezone

• runtime_mrt_ert_percent

• runtime_mrt_fixed_seconds

• runtime_mrt_fixed_timestamp

• runtime_srt_method (ERT, FIXED, NONE)

• runtime_srt_ert_percent

• runtime_srt_fixed_seconds

• runtime_srt_fixed_timestamp

• variables (Liste)

  • name
  • value
  • usage

• promptsets (Liste)

  • name

  • elements (Liste)

    • variable
    • default_value
    • tooltip
    • label
    • required
    • type

• rollback

• rollback_backup_object

• rollback_backup_directory

• rollback_object

• rollback_include_subdirs

• rollback_delete_before_restore

• deactivate_when

• deactivate_delay

• deactivate_type (AFTER_ERROR_FREE_EXEC, AFTER_ERROR_FREE_RESTART, ALWAYS, NEVER)

• extended_reports (ALL, DEFAULT, NONE)

• usage (Diese Liste ist nur verfügbar wenn die Option für die Verwendungssuche gesetzt ist)

  • name
  • type
  • folder
  • package
  • usage

CALE

• keywords (Liste)

  • name

  • type

  • dates (Liste)

    • year
    • month
    • day

CALL

• call_priority (HIGH, MEDIUM, LOW)

• call_type (EMAIL, MESSAGE, ALARM, REQUEST)

• attach_file

• attach_report

• attach_report_source

• subject

• message

• recipients (Liste)

  • email
  • operator
  • calendar_name
  • calendar_keyword

CONN (CIT)

• connection_name
• solution_name
• RA-Attribute, die aus einem Export entnommen werden können

CONN (R3)

• connection_type (HTTP, RFC)

• http_login

• http_url

• http_user

• rfc_login

• rfc_max_connection

• rfc_conn (SERVER, GROUP)

• rfc_conn_sap_router

• rfc_conn_instance_id

• rfc_conn_system_id

• rfc_conn_message_server

• rfc_conn_application_server

• rfc_conn_group

• rfc_sap_client

• rfc_sap_user

• rfc_sap_language

• xal_monitor

• xal_monitor_set

• xal_monitor_shortname

• xal_version

• xal_system_log

• bw_chains_parallel

• bw_extended_monitoring (REPEAT_CHECK, UNTIL_MAX_RUNTIME, NO)

• bw_repeat_status_checks

• bw_repeat_data_checks

• bw_ipak_change

• xbp_spool_block_size

• xbp_audit_level

• xbp_version

• xbp_combine_steps

• xbp_use_ae

• xbp_confirm_event_history

• smse_start

• smse_ae_user

• smse_ae_department

• smse_ae_client

• smse_destination

• smse_gateway_host

• smse_gateway_service

• smse_program_id

• snc_library

• snc_my_name

• snc_partner_name

• snc_security_level

• CONN (SQL)

• login

• alternative_user

• db_server

• db_port

• db_type (ACCESS, DB2, EXASOL, GENERIC, HANA, INFORMIX, INGRES, MAXDB, MS_SQL, MY_SQL, ORACLE, ORACLE_OCI, POSTGRESQL, SYBASE)

• db_name

• jdbc_connect

• properties (Liste)

  • name
  • value

• parameters (Liste)

  • name
  • value

CPIT

• controls (Liste)

  • type (CONTROL, FRAME)
  • caption
  • height
  • width
  • left
  • top
  • id
  • data_source_variable (für den Typ CONTROL)
  • data_source_key (für den Typ CONTROL)

DOCU

EVNT (allgemein)

• calendar_items (Liste)

  • calendar
  • keyword
  • from
  • to

• process

• event_process

EVNT (DB)

• operator
• op1_source (QUERY, STATIC, VARA)
• op1_server
• op1_database
• op1_agent
• op1_login
• op1_access_file
• op1_sql
• op1_static_value
• op1_variable_name
• op1_variable_key
• op2_source (QUERY, STATIC, VARA)
• op2_server
• op2_database
• op2_agent
• op2_login
• op2_access_file
• op2_sql
• op2_static_value
• op2_variable_name
• op2_variable_key
• activate_mode (AUTO, INTERVAL, START_TIME)
• activate_interval
• activate_at_minutes
• activate_at_timestamp
• frequency (REPEAT, SINGLE, FIRST_HIT)
• first_activation (AFTER_EXPIRE, IMMEDIATELY)

EVNT (TT)

• activate_mode (AUTO, INTERVAL, START_TIME)
• activate_interval
• activate_at_minutes
• activate_at_timestamp
• frequency (REPEAT, SINGLE)
• first_activation (AFTER_EXPIRE, IMMEDIATELY)

EVNT (FT)

• condition (PATH_FILE_COUNT, FILE_SIZE, PATH_SPACE_USED, PATH_SPACE_UNUSED, FILESYSTEM_SPACE_FREE)
• operator
• path
• value
• unit
• activate_mode (AUTO, INTERVAL, START_TIME)
• activate_interval
• activate_at_minutes
• activate_at_timestamp
• frequency (REPEAT, SINGLE, FIRST_HIT)
• first_activation (AFTER_EXPIRE, IMMEDIATELY)
• include_subdirs
• extra_condition (CHANGED, STABLE, NONE)
• extra_condition_within_seconds
• extra_condition_within_timestamp

EVNT (CONS)

• frequency (REPEAT, FIRST_HIT)

• agent

• type (WIN, SAP, BS2000, OS390, OS400)

• für den Typ WIN

  • win_source

  • win_type

  • win_category

  • filters (Liste)

    • event_id
    • type (ERROR, WARNING, INFORMATION, SUCCESS_AUDIT, FAILURE_AUDIT)
    • user
    • message_filter

• für den Typ SAP

  • sap_login

  • sap_data_source (ABAP, JAVA, XI)

  • filters (Liste)

    • event_id
    • event_parameter
    • event_server

• für den Typ BS2000

• filters (Liste)

  • name

• für den Typ OS390

  • os390_os_name

  • os390_system_name

  • events (Liste)

    • job_name
    • message_filter

• für den Typ OS400

• os400_message_type

• os400_severity

• events (Liste)

  • message_id
  • message_filter

FILTER

• operator

• reports (Liste)

  • source
  • operator
  • filter

• outputs (Liste)

  • source
  • operator
  • filter

• files (Liste)

  • source
  • operator
  • filter

HOST

HOSTG

JOBF

• consumption

• is_attribute_dialog

• dst_host

• dst_login

• dst_file

• dst_attributes

• src_host

• src_login

• src_file

• src_attributes

• file_exists (OVERWRITE, CANCEL, APPEND)

• format (BINARY, TEXT)

• erase_source

• include_subdirs

• keep_file_attributes

• transfer_folder_structure

• wildcards

• compression (DEFAULT, NO, YES)

• abort_at_first_error

• max_parallel_transfers

• output_scan (Liste)

  • name
  • condition
  • retcode
  • status_text
  • execute

• process

• post_process

JOBG

• children_queue

JOBI

• process

JOBQ

• process
• post_process
• child_post_process

JOBQ (R3)

• filter_job_without_startdate
• filter_external_job_children_only
• filter_job_with_predecessor
• filter_client
• filter_event_id
• filter_event_parameter
• filter_job_count
• filter_job_group
• filter_job_name
• filter_job_status
• filter_schedule_start_greater
• filter_schedule_start_less
• filter_user_name

JOBS (allgemein)

• object_ratype

• consumption

• host

• host_type

• login

• code

• output_list (Liste)

  • filename
  • login

• output_scan (Liste)

  • name
  • condition
  • retcode
  • status_text
  • execute

• pre_process

• process

• post_process

JOBS (UNIX)

• unix_type
• unix_command
• unix_shell
• unix_shell_options

JOBS (Windows)

• win_command
• win_workdir
• win_type (BAT, COM, INTERPRETER)
• win_view
• win_job_object
• win_batch_user
• win_show_desktop

JOBS (SAP)

• sap_language

• sap_job_name

• sap_job_class

• sap_target_system

• sap_delete_job (YES, NO, ON_ERROR)

• sap_use_login_object

• sap_start_type

• sap_report_generate (ALWAYS, ERROR_ONLY)

• sap_report_stores (Liste)

  • name (FILE, DATABASE)

• sap_report_add_agent_log

• sap_report_add_application_log

• sap_report_add_statistics

• sap_report_add_spool_directory

• sap_report_add_step_list

• sap_recipient

• sap_recipient_address_type (NAME, PRIVATE_DISTRIBUTION_LIST, SHARED_DISTRIBUTION_LIST, SAP_OFFICE_USER, SAP_USER, INTERNET_ADDRESS, X400_ADDRESS, SAP_USER_ANOTHER_SYSTEM, EXTERNAL_ADDRESS, FAX_NUMBER, X500_ADDRESS, TELEX_NUMBER, ORGANIZATIONAL_UNIT, SAP_OBJECT, ORGANIZATION_OBJECT, PAGER_SMS, OTHERS)

• sap_recipient_report_send_status

• sap_recipient_report_status_by_mail

• sap_recipient_no_forward

• sap_recipient_blind_copy

• sap_recipient_copy

• sap_recipient_send_express

• sap_recipient_no_print

JOBS (RA)

• ra_task_parameters
• RA-Attribute, die aus einem Export entnommen werden können

JOBS (SQL)

• sql_connection
• sql_db_server
• sql_db_name
• sql_max_chars
• sql_max_rows
• sql_column_separator
• sql_separator_substitute
• sql_show_headlines
• sql_show_null_as_empty
• sql_remove_linebreak

JSCH

• process

JOBP (allgemein)

• ok_execute
• ok_state
• process
• graph (Liste) enthält im Gegensatz zum Attribut tasks auch die besonderen Aufgaben START, END, IF, FE

JOBP (Standard, ForEach)

• tasks (Liste)

  • name

  • alias

  • alias_or_name

  • package

  • active

  • x

  • y

  • breakpoint

  • run_no

  • external

  • request_user_input_at_start

  • request_user_input

  • pre_conditions

  • post_conditions

  • checkpoint

  • checkpoint_execute

  • checkpoint_days

  • checkpoint_time

  • checkpoint_timezone

  • runtime

  • runtime_execute

  • runtime_cancel

  • earliest

  • earliest_days

  • earliest_time

  • earliest_timezone

  • else_mode (SKIP, BLOCK, ABORT, BLOCK_ABORT)

  • else_execute

  • latest

  • latest_mode (START, END)

  • latest_end_days

  • latest_end_time

  • latest_start_days

  • latest_start_time

  • successors (Liste)

    • name
    • state
    • run_no
    • package
    • x
    • y

  • dependencies, predecessors (Liste)

    • name
    • state
    • run_no
    • package
    • x
    • y

  • calendar_match (ALL, EXT, NONE, ONE)

  • calendar_conditions (Liste)

    • calendar
    • keyword

  • promptsets (Liste)

    • name

    • elements (Liste)

      • variable
      • default_value
      • tooltip
      • label
      • required
      • type

  • variables_inherit

  • variables (Liste)

    • name
    • value
    • usage

  • only for external dependencies

    • external_within_parent
    • external_alias
    • external_check_same_logical_date
    • external_check_expected_status
    • external_check_mode (AFTER_LAST_START, BEFORE_START, AFTER_START)
    • external_check_before_seconds
    • external_check_before_timestamp
    • external_else_mode (WAIT, SKIP, CANCEL)
    • external_else_alarm
    • external_else_execute
    • external_else_timeout
    • external_else_alarm_timeout
    • external_else_alarm_timeout_seconds
    • external_else_alarm_timeout_timestamp

  • object (Struktur)

    • Dieses Attribut ist nur im erweiterten Modus verfügbar und beinhaltet alle Attribute des Objektes, dass zu dieser Aufgabe gehört. Da es sich hierbei um eine Struktur handelt können die Attribute mit der Präfix object. angesprochen werden (z.B. object.title)

  • usage (Diese Liste ist nur verfügbar wenn die Option für die Verwendungssuche gesetzt ist)

    • name
    • type
    • folder
    • package
    • usage

JOBP (If)

• tasks_true (Liste)

  • gleiche Attribute wie für JOBP Standard

• tasks_false (Liste)

  • gleiche Attribute wie für JOBP Standard

LOGIN

• definitions (Liste)

  • host
  • hosttype
  • info
  • vault

PRPT

• fields (Liste)

  • type (COMBO, LABEL, NUMBER, CHECKLIST, CHECKGROUP, DATE, TIME, TEXT, TIMESTAMP, RADIOGROUP, UNKNOWN)
  • variables
  • default_value
  • custom_field
  • tooltip
  • internal_name
  • caption
  • data_reference

QUEUE

• max_slots

• priority

• timezone

• exceptions

  • from
  • to
  • calendar
  • keyword
  • max_slots
  • priority
  • description

SCRI

• process

SLO

• slo_monitoring_enabled
• monitor_permanently
• monitor_restricted
• monitor_start
• monitor_end
• consider_mrt
• consider_srt
• consider_end_status
• expected_end_status
• consider_latest_start_time
• latest_start_time
• consider_latest_end_time
• latest_end_time
• is_monday
• is_tuesday
• is_wednesday
• is_thursday
• is_friday
• is_saturday
• is_sunday
• execute_on_fulfillment_enabled
• execute_on_fulfillment_object
• execute_on_violation_enabled
• execute_on_violation_object

STORE

• resources (Liste)

  • name
  • filename
  • content_type
  • size
  • hardware
  • software
  • version
  • checksum
  • platform

SYNC

• actions (Liste)

  • action
  • on_operator
  • on_state
  • on_value
  • new_operator
  • new_state
  • new_value

• states (Liste)

  • state
  • description

VARA (Allgemein)

• data_type (TEXT, NUMBER, DATE, TIME, TIMESTAMP)
• text_limit_length
• text_max_length
• number_format
• number_set_min_value
• number_min_value
• number_set_max_value
• number_max_value
• time_format
• time_set_min_value
• time_min_value
• time_set_max_value
• time_max_value
• date_format
• date_set_min_value
• date_min_value
• date_set_max_value
• date_max_value
• timestamp_format
• timestamp_set_min_value
• timestamp_min_value
• timestamp_set_max_value
• timestamp_max_value
• script_access (ERROR, INITIAL_VALUES)
• source (BACKEND, EXEC, FILELIST, STATIC, SQL, SQLI, SQL_SECURE, SQLI_SECURE, XML, MULTI)

VARA (BACKEND)

• result_format

• agent

• apply_task_agent

• login

• apply_task_login

• unix_commands (Liste)

  • os
  • version
  • command
  • column_format

• windows_commands (Liste)

  • os
  • version
  • command
  • column_format

VARA (FILELIST)

• directory
• agent
• apply_task_agent
• login
• apply_task_login

VARA (SQL)

• connection

• login

• sql

• result_format

• VARA (SQLI_SEC)

• connection

• login

• sql

• result_format

• bind_parameters (Liste)

  • number
  • variable

VARA (SQLI)

• sql_db2
• sql_mssql
• sql_oracle
• result_format

VARA (SQLI_SEC)

• sql_db2

• sql_mssql

• sql_oracle

• result_format

• bind_parameters (Liste)

  • number
  • parameter

VARA (EXEC)

• exec_object

• result_variable

• parameters (Liste)

  • name
  • value

• VARA (MULTI)

• variable1

• variable2

• operation (INTERSECTION, MINUS, UNION)

• VARA (STATIC)

• sort_column (KEY, VALUE1, VALUE2, VALUE3, VALUE4, VALUE5)

• sort_order (ASCENDING, DESCENDING)

• entries (Liste)

  • key
  • value1
  • value2
  • value3
  • value4
  • value5

• VARA (XML)

• entries (Liste)

  • key
  • value

RA-Objekte (Verbindungen und Jobs) besitzen viele generische Attribute, die abhängig von der jeweiligen Solution sind. Diese Attribute werden genauso übernommen wie sie auch im XML-Export der Objekte zu finden sind.

Um die Liste der Attribute mit den Werten beim Lauf des Moduls zu sehen kann der Log-Level DEBUG gesetzt werden. In dem Fall werden alle Attribute im Bericht ausgegeben.