Job logs

Job logs

Whenever InterFormNG2 is processing a job a related job log is also created. The job log lists all details, outputs and possible errors/warnings concerning a specific input file.

The details for the job logs are divided into these sections:

1.Setup for how long entries in the job logs should be kept.

2.Setup an optional email receiver in case of errors during processing. Alternative error handling can be done in the workflow.

3.How to set a job log key.

4.Search in job logs

5.Details of a job log entry.

6.Export a job log e.g. for support tickets.

7.Jump to the workflow. From the job log you can now jump directly to the used workflow via a link.

 

You can see the job logs, if you click Job logs in the InterFormNG2 top ribbon:

 

NG2JobLog0001

 

Then you see a list of the processed files:

 

NG2JobLog0002


How to set a job log key:

On the list of job logs there is a column 2 named File name or key.

 

Normally this column lists the name of the input file, but you can set a key value for this during processing in the workflow, so that you can uniquely identify the input file from this view and e.g. even search for this unique key.

 

To set a log key value you should use the workflow component: Log info key component for a single job log entry for a job. Alternatively you can use the New log line workflow component, if a single job should create multiple entries in the job log. This is e.g. the case, if the job log is to split the input file and you want one entry for each of the splitted files. In this case it is recommended to insert the New log line component as the first component directly after the split.

Search in Job logs :

You have multiple ways to search for a specific job log in the list of all processed files in InterFormNG2:

 

NG2JobLog0003

 

The status reflects the highest error severity found during processing. The status of the individual job logs is indicated by the color:

 

Status

Color

OK

Grey/black

Warning

Yellow/orange

Error

Red

 

To search you first need to type in or select the parameters on the top and then click the blue search icon. The search key(s) are setup with the workflow component, Log Info key.


There are two search options:

 

1.A normal search

2.Advanced search

 

This section covers the normal search options.


The search is case insensitive.

 

You can find the normal search in the top left of the job log search:


If this section is folded, then you can unfold it by clicking the arrow on the right:


 

As the search text you can use AND and OR and even () in order to define a more advanced search. If you combine multiple search fields in the components, Log info key and New log line, then you can here do an advanced search. If you e.g. search for "Invoice AND (_Bo OR _Kim)", then you will see the list of joblogs, that concerns invoices created by Kim or Bo (here an underscore is used as a delimiter and this is used in order to avoid false matches as the search is searching the complete job log.

 

If the search takes long a waiting animation is shown while InterFormNG2 is searching the logs.

 

The parameters are:

 

Module

If you want to restrict the list to only include entries, that are using a specific module in InterFormNG2, then you can use this. The drop down list only shows the modules, that have been used on the machine, so only a subset of all modules are shown.

 

Status

The status of the processing. Possible values are:

ALL

List jobs with all statuses.

OK

List only jobs, that processed without any errors or warnings

Warning

List only jobs, that issued a warning during processing.

Error

The list of jobs, that stopped with an error.

 

Older than

Here you can type a date in the format yyyy-mm-dd. Any job log entry older than this date is shown, when you click search.

 

Text

Here you can type in a search text. The search in case-insensitive. Any job with a file name or job log key, that contains the search text is shown.

 

Scroll

On the right you can click the arrows next to < PAGE 1 > to roll up or down in the list.

Apart from the options mentioned for the normal search above there are some extra options for the advanced search, which you can select below the normal search:


When you unfold the advanced search option you will see this:


As for the normal search you can use AND/OR within the text to setup a more complex search, but for the advanced search you also have the operator on the right, which can be AND or OR.

 

The example above only selects the job logs where all the three conditions are true.

 

The advanced search has these parameters apart from the parameters of the normal search:

 

Log Info

This relates to the log info keys, which are e.g. set with the Log info key workflow component or set as predefined variables.

If Log Info is set to ALL, then all the log info keys (1,2 and 3) are searched for the text written in the same row.

If Log Info is set to Log Info 1, then only the Log Info 1 (also referenced as Log Info) is searched.

If Log Info is set to Log Info 2, then only the Log Info 2 is searched.

If Log Info is set to Log Info 3, then only the Log Info 3 is searched.

 

Exact Word

If you enable this option, then the search will only find the job log entries, which match the whole word. If you e.g. search for Ken, and you want to match that as the full name of the customer while ignoring longer names like Kenneth, Kenny etc., then you can enable this option.

 

Operator

The operator can be either AND or OR.

 

Trash can icon

Use the trash can icon to delete the conditioned line.

 

Add more

Click this to add another conditioned line.

 

Search

Click this in order to start the search.

 

 

You might feel tempted to setup a search like in the image below as an alternative to the search expression: Invoice AND (_Bo OR _Kim), but these searches are NOT the same. Normal boolean logics apply which means that AND's must be executed before the OR's.

 

The expression: Invoice AND (_Bo OR _Kim) and the expression (as below) : Invoice AND _Bo OR _Kim are very different.

 

This expression: Invoice AND (_Bo OR _Kim) is true if Invoice is found and either _Bo or _Kim is found - or both.

 

The expression Invoice AND _Bo OR _Kim is true if either Invoice and _Bo is found - or if only _Kim is found..

 

Details of a job log entry :

When you click one of the entries in the job log list, then you can see all the details of the processing of the input files including what kind of output, that was generated.

 

When you click the entry you will see something similar to this:

 

NG2JobLog0004

 

Here you can click each of the icons, and InterFormNG2 will then display the details of the element on the right part of the screen.

Here I have e.g. clicked this icon:

 

NG2JobLog0005

 

And then I see the details on the right:

 

NG2JobLog0006

 

Hide log levels below

On the top you can choose to only display some of the detail lines (only those that contains a specific text), and also choose hide details under a specific severity. The severity go from Trace, that lists all details down to Fatal, that lists only details of fatal error.

 

The name of the workflow, that ran the job

You can see the name of the workflow, that generated the job log, if you open the export of the job log. Inside the job log xml file you can see this:

 

NG2JoblogExport0001

 

The workflow name is mentioned both in the translated node and the parameters node, so the workflow name is in this case: Excel input123.

Export of a job log :

For e.g. support tickets it can be useful to export a job log as an xml file. You can do that, if you open the list of job logs, and then expand the job log, that you want to export:

 

NG2ExportJobLog0001

 

Here you can click the export option on the right as marked above. When you click this icon, the you will download an xml file with the job log.

 

The job log xml file looks similar to this:

 

NG2ExportJobLog0002

 

 

One of the informations, that you can find inside the job log is the name of the workflow.

Jump to workflow from job log :

You can jump directly to a workflow, while you look at an entry in the job log, if you click the Jump to workflow icon as below:

 

NG2JumpToWorkflowFromJobLog0001

 

When you click that you immediately jump from the job log into the used workflow.

    • Related Articles

    • APIs for job logs

      Below the APIs for job logs are listed. APIs are introduced here. Get job log names This returns a list of all the logger names that are used in the job log. These can be used as filter criteria when searching the job log. GET ...
    • Logs

      In InterFormNG2 there are 8 types of logs: The job logs. This contains details information of what happened during processing of each input file. This can be used by non-technical users. A system log. The core log of InterFormNG2. This is advanced ...
    • Adding new job records in a database

      New job records can be added to the database table by inserting rows in the "job" table. For new jobs, the following columns are used: Column Type Mandatory Value Description processed Integer Yes 0 Indicates processing status of the job. 0 = ...
    • Other tenant settings

      This section lists other/some tenant settings in InterFormNG2. There are two other groups of tenant settings: Designer tenant settings. Workflow tenant settings. The other tenant settings are: Delay queue - Configuration for PDF delayed emails. With ...
    • System log

      For normal use the job logs should be used in order to check up on processing of files, but in some rare cases you might need to look into the system log of InterFormNG2. To access the system log you need to sign on as a system admin. The system log ...