Skip to main content
Version: 7.0

Package: Build Documentation

This module generates documentation for objects of a package. The documentation is based on template that can be created for each object type. The format (text based) can be chosen freely. Examples for possible output formats are be HTML, Confluence Storage Format, Markdown or SVG.

Designation​

Name
pm.DocBuilder
Aliases
DocumentationGenerate, pm.DocumentationGenerate, pm.PackageDocumentationGenerate

Configuration​

Package (package)
Name of the package
Template directory (template-dir)
Directory containing the template files
Template Variable (template-vara)
A static variable object mapping the object type to an object containing the template for the documentation.
Connection (template-source)
If given the template variable is read from this connection. Otherwise it is read from the standard connection.Mögliche Werte: <TabItem b4A Verbindungen>
Output directory (output-dir)
The generated documentation will be stored in this directory
Output Variable (output-vara)
The generated documentation will be stored in a static variable object
Output character encoding (output-encoding)
Character encoding for the output files. If none is specified, the default encoding of the JVM is used.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)
Search for usage of runnable objects and workflow tasks (extended-usage)
Searches for the usage of runnable objects and workflow tasks and provides a list of references of the objects.
Search for Usage Level (extended-usage-level)
Level for the search of usage which can be set to package objects and/or workflow tasks.Mögliche Werte: Objects and Workflow Tasks (objects-and-tasks), Objects only (objects-only)
Search for usage of runnable objects and workflow tasks (including processes) (extended-usage-with-processes)
Searches for the usage of runnable objects and workflow tasks and provides a list of references of the objects. References in processes are included.
Extended Workflow Attributes (extended-workflow-attrs)
Activates an extended set of workflow attributes. For each task of the workflow all attributes of the object will be available. The names of the attributes are the same as for the objects with the prefix 'object.'
Extended PromptSet Attributes (extended-promptset-attrs)
if activated, promptsets of workflow tasks can be described in more detail
Replace b4A expressions in text documentation (b4a-expression-docu)
If set b4A expressions will be replaced in the text documentation of objects
Convert to JSON string (convert-to-json-string)
The option forces the output to be converted to a string compatible with JSON
Custom Attributes (File) (custom-attributes-file)
A CSV file containing a list of custom attributes that should be available when building the documentation
Custom Attributes (custom-attributes)
A list of custom b4A expression attributes. Each entry is defined as a key-value pair in the format key=value.
Index Template (index-template-name)
Defines the name of the template for the package index

Description​

b4A Expressions are used to insert the values of the objects to be documented in the templates. Simple replacements and functions can be used (Details).

The templates for the documentation can either be stored in files or saved in documentation objects. If files are used, they must follow a naming scheme. The extension of each template file can be chosen as desired and is appended to the output file if the output is in files. The rest of the name must correspond to an object type (example: JOBS.html). For object types with subtypes, additional templates can be created for the subtypes (example: JOBS_UNIX.html). The additional attributes for the subtypes can only be used in such templates. There is a variant for RA jobs. The RA type can also be used here instead of the subtype (example: JOBS_WEBSERVICEREST.html).

As many object types have the same attributes and there are always the same beginnings and ends of the templates when using some formats, the module provides the option of making additional templates available for the headers and ends of the documents. The template for the header must be called #HEADER and the template for the end #FOOTER. If the templates are provided as files, the file names can also have any extension (e.g. #HEADER.html).

Optionally, separate headers and endings can be provided for executable objects. These must be called #HEADER_RUNNABLE and #FOOTER_RUNNABLE. If these are not available, the other templates are used. If none of these special templates are available, the entire content for the documents to be created must be contained in the object type templates.

Output & coding​

The generated documentation can be written to files. For this purpose, an output directory is specified in which a file is created for each object. The output files are usually created with the character encoding of the JVM. For Windows this is normally windows-1252, for Unix UTF-8. In some cases it may be necessary for the files to have a different character encoding for better further processing. The character encoding can therefore be freely selected in the module. All character sets known to the respective Java installation are available for selection. However, at least US-ASCII, ISO-8859-1, UTF-8, UTF-16BE, UTF-16LE and UTF-16. Furthermore, the output can also take place in a static variable object. In this case, the key is the object name and the first value contains the generated documentation.

Using Groovy in templates​

The support the Groovy programming language with the SCRIPT function. If this is used in the context of the pm.DocBuilder module, there is an extension. If the templates for the documentation are located in a directory, it is possible to store Groovy classes in a subdirectory and import them. This provides a better structure for complex templates.

*Directory tree

Template directory (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() )
Attributes​

An additional template with the name INDEX can optionally be defined. This can be used to generate an overview of the package. The following attributes are available when generating based on this template.

  • package_name

  • package_version

  • package_description

  • package_basefolder

  • package_dependencies

  • package_dependency_list (list)

    • package
    • operator
    • version

  • package_metadata (list)

    • key
    • value

  • package_documentation

  • package_release_notes

  • ae_system

  • ae_client

  • b4a_connection

  • objects (list)

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

When using documentation objects, a variable object containing an index must also be used. The key is the object type and the name of the documentation object is entered in the first value. In the documentation objects, the text of the template must be entered on the first text documentation tab.

The list of defined attributes for the object types is listed below. For attributes that contain lists, this is noted accordingly and the attributes are specified for each element.

*All objects

  • package_name

  • package_version

  • package_description

  • package_basefolder

  • package_folder

  • package_dependencies

  • package_dependency_list (list)

    • package
    • operator
    • version

  • package_metadata (list)

    • 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

  • The individual elements of the XML documentation are also provided as attributes. The names of the attributes are generated from the XML path. If the tab of the XML documentation is called 'Details' and there is a Link element below the Content element, then the attribute would be called Details_Content_Link. In addition, there would be the attribute Details_Content_Link_attributes, which contains a list of the XML attributes.

    • <XML element>

    • <XML element>_attributes (list)

      • name
      • value

*All startable objects

  • active

  • custom_attributes (list)

    • name
    • value

  • int_account

  • queue

  • start_type

  • generate_at_runtime

  • priority

  • timezone

  • max_parallel_tasks

  • max_parallel_mode (CANCEL, WAIT)

  • sync_list (list)

    • sync_object
    • start
    • end
    • 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 (list)

    • name
    • value
    • usage

  • promptsets (list)

    • name

    • elements (list)

      • 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 (This list is only available if the option for the usage search is set)

    • name
    • type
    • folder
    • package
    • usage

*CALE

  • keywords (list)

    • name

    • type

    • dates (list)

      • 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 (list)

    • email
    • operator
    • calendar_name
    • calendar_keyword

CONN (CIT)

  • connection_name
  • solution_name
  • RA attributes that can be taken from an export

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 (list)

    • name
    • value

  • parameters (list)

    • name
    • value

CPIT

  • controls (list)

    • type (CONTROL, FRAME)
    • caption
    • height
    • width
    • left
    • top
    • id
    • data_source_variable (for the CONTROL type)
    • data_source_key (for the CONTROL type)

DOCU

EVNT (general)

  • calendar_items (list)

    • 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)

  • *for the WIN type

    • win_source

    • win_type

    • win_category

    • filters (list)

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

  • for the SAP type

    • sap_login

    • sap_data_source (ABAP, JAVA, XI)

    • filters (list)

      • event_id
      • event_parameter
      • event_server

  • *for the type BS2000

  • filters (list)

    • name

  • *for type OS390

    • os390_os_name

    • os390_system_name

    • events (list)

      • job_name
      • message_filter

  • *for type OS400

  • os400_message_type

  • os400_severity

  • events (list)

    • message_id
    • message_filter

*FILTER

  • operator

  • reports (list)

    • source
    • operator
    • filter

  • outputs (list)

    • source
    • operator
    • filter

  • files (list)

    • 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 (list)

    • 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 (general)

  • object_ratype

  • consumption

  • host

  • host_type

  • login

  • code

  • output_list (list)

    • filename
    • login

  • output_scan (list)

    • 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 (list)

    • 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 attributes that can be taken from an export

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 (general)

  • ok_execute
  • ok_state
  • process
  • graph (list) in contrast to the tasks attribute, also contains the special tasks START, END, IF, FE

JOBP (standard, ForEach)

  • tasks (list)

    • 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 (list)

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

    • dependencies, predecessors (list)

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

    • calendar_match (ALL, EXT, NONE, ONE)

    • calendar_conditions (list)

      • calendar
      • keyword

    • promptsets (list)

      • name

      • elements (list)

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

    • variables_inherit

    • variables (list)

      • 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 (structure)

      • This attribute is only available in extended mode and contains all attributes of the object that belongs to this task. As this is a structure, the attributes can be addressed with the prefix object. (e.g. object.title)*.

    • usage (This list is only available if the option for the usage search is set)

      • name
      • type
      • folder
      • package
      • usage

JOBP (If)

  • tasks_true (list)

    • Same attributes as for JOBP Standard

  • tasks_false (list)

    • Same attributes as for JOBP Standard

*LOGIN

  • definitions (list)

    • host
    • hosttype
    • info
    • vault

*PRPT

  • fields (list)

    • 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 (list)

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

*SYNC

  • actions (list)

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

  • states (list)

    • state
    • description

VARA (General)

  • 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 (list)

    • os
    • version
    • command
    • column_format

  • windows_commands (list)

    • 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 (list)

    • 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 (list)

    • number
    • parameter

VARA (EXEC)

  • exec_object

  • result_variable

  • parameters (list)

    • 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 (list)

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

  • VARA (XML)

  • entries (list)

    • key
    • value

RA objects (connections and jobs) have many generic attributes that are dependent on the respective solution. These attributes are adopted in exactly the same way as they are found in the XML export of the objects.

To see the list of attributes with the values when the module is run, the log level DEBUG can be set. In this case, all attributes are displayed in the report.