Batch job service

The Batch Job Service introduces customers to an intuitive web-based user interface within Connect, enabling remote configuration and execution of PML macros on a scheduled basis.

This feature serves as a pivotal tool for both maintenance and generation of design deliverable outputs from AVEVA E3D, AVEVA Engineering and AVEVA Administration Dabacon products.

Clients can now elevate their operational efficiency by automating critical scheduled batch processes. These processes stand as integral components within customers on-premises workflows. These unsupervised automated activities can be set to run overnight or during non-standard working hours, to curtail disruptions to live projects.

• Enhanced Deliverable Export Streamlining: Seamlessly export an array of deliverables, encompassing 3D model review files and engineering drawings.

• Optimal User Management: Exercise precise control over user management, proficiently removing users and perpetuating system performance.

• Database Integrity Checks: Ensure the integrity of your databases using automated dice check macros for more accurate and reliable data.

Granting Access to the 'Manage Batch Jobs' Page

Default Access

By default, the CONNECT account administrator has access to the Manage Batch Jobs page.

Granting Access to Additional Users

To extend this access to other users, the CONNECT account administrator needs to assign the Admin Superuser service role to a specific group.

Any user added to this group for the relevant folder will subsequently gain access to the Manage Batch Jobs page.

Manage Batch Jobs Page

On entering your CONNECT account, enter the Unified engineering tile for your chosen folder in which you want to manage batch jobs for.

On the hamburger menu the Manage batch jobs option should be visible (providing that user is a CONNECT Administrator or Admin Superuser).

Creating a Batch Job

Click on Manage batch jobs to open the Manage batch jobs page.

To Create a Batch Job, Click Create Batch Job.

The Batch Job Details section enables you to input the job title, description (optional) and enter the Project name, which is a unique 3-digit project identifier, as demonstrated here: APS.

Setting a Schedule

The Schedule Details section enables users to establish a daily or weekly schedule for their batch job. At the end of each field, a user-friendly drop-down menu is provided for selecting the desired input.

Note: This can be inputted in the local regional time of the user, conversions will be done automatically

In the example below, you can see a schedule set to execute every weekday from Monday to Friday at 6 PM. After configuring your desired schedule, please select the 'Enabled' checkbox to activate it. Alternatively, if you want to keep it inactive, clear the 'Enabled' checkbox.

Batch Job Parameters

The Batch Job Parameters section enables you to select the application module where you intend to run your PML macro and upload your 'pmlmac' and '.mac' credential files.

Note: The list of applications and modules shown in drop down menu above represents the exclusive set officially supported by our service. We do offer support for switching between modules, which allows for flexibility in customization. However, we strongly discourage switching the primary application, as it may result in inaccurate execution statuses.

PML Macro file

Selecting the browse button adjacent to the PML Macro field enables users to navigate to a folder location to find the desired macro to be upload (This needs to be in .pmlmac format)

PML Credential file

Selecting the browse button adjacent to the PML credentials file field enables users to navigate to a folder location to find the entry script to be upload (This needs to be in .mac format)

Credential Files (Product Entry Scripts)

AVEVA Administration provides the capability to generate an encrypted script designed for accessing an AVEVA product with specified parameters: a Project, a User, and an MDB to execute upon session initiation. These 'Entry Scripts' macros encompass essential details necessary for entering a project in a module.

For further details on entry scripts please see AVEVA Administration System Administration guides and manuals.

The use of macros referencing other macros using $m adds complexity and is not supported where possible please directly calling arguments and variables within the sole macro.

Enter the desired project in AVEVA Administration

Navigate to the "Admin Elements" section and choose the "MDB" type in the left-hand box. Then, proceed by clicking the Create Script button, initiating the command script generation form.

Please complete the following steps:

1. Fill in the project details.

2. Enter your username and password.

3. Choose the desired MDB from the dropdown menu where you want to execute the job within the selected project.

4. To save the .mac file, simply follow these steps:

5. Click on the 'Browse' button to choose a suitable location.

   

Using Execute Now

To execute batch jobs and conduct ad hoc testing, an "Execute Now" can be function is used. The function will initiate batch jobs on demand, bypassing the predefined scheduling.

To initiate and execute the process, simply click the 'E' icon located on the main page for managing batch jobs. Upon doing so, an information form appears, notifying you that the process has been initiated.

To proceed, click OK to close the form.

Another option for triggering an immediate execution is available on the "View Batch Job" page. Simply click Execute Now in the top right corner to initiate the process.

Troubleshooting & Log Files

To facilitate auditing and monitor execution status, you can easily access log files. These log files can be found by following these steps:

Go to the 'View Batch Job' page.

Access the 'View Batch Job' page by clicking the blue label link on the Job tile, as depicted in the below screenshot.

In the batch job details page you can view execution history and execution status of the selected job.

To view and troubleshoot jobs you can select the blue label link on the left-hand side.

Below is an example of a Successful job.

Migrating on-premises macros

While migrating on-premises macros, recommendations are to:

• Remove commands that launch another application or module within the macro.

• FINISH commands in macros should be removed as job parameters handle completion.

• Do not reference other macros. Instead, consider directly calling arguments and variables within the scheduled job macro.

• Since the service operates headless on a server, the Batch Job service does not support automation with PML procedures that require Device Graphic (DEV GRA) mode.