Versions Compared

Version Old Version 1 New Version Current
Changes made by

Jenni Wallin

Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The BatchData APL functions are used for managing the work orders and work logs used in the Usage Management Workflow Templates.

The BatchData Support functions include:

...

Table of Contents

...

pccBatchDataAddWorkorder

...

pccBatchDataBeginWorklogs

...

pccBatchDataAddWorklog

...

pccBatchDataAddWorklogs

...

pccBatchDataSuspendWorklogs

...

pccBatchDataResumeWorklogs

...

pccBatchDataGetWorkorders

...

pccBatchDataGetWorklogs

...

pccBatchDataRemove

maxLevel1

pccBatchDataBeginWorkorders

This function enables a list with work orders to be created for a session context. When this function has been called, the session context field in the UDR can be populated with the list of work orders.

Code Block
void pccBatchDataBeginWorkorders( long txnId )

Parameters

ParameterDescription

txnId

The transaction ID of the session context for which you want to create a list of work orders


Info
titleExample


Code Block
pccBatchDataBeginWorkorders(cycle.TxnId);

will allow the session context field in the cycle UDR with the stated transaction ID to be populated with a list of work orders.

pccBatchDataAddWorkorder

This function adds a work order to a session context. In the real-time template, this function is used for adding work orders that have been validated successfully to the session context, for example.

Code Block
void pccBatchDataAddWorkorder( long txnId, Workorder data )

Parameters

ParameterDescription

txnId

The transaction ID of the session context in which a work order should be added.

data

The work order to add.


Info
titleExample


Code Block
pccBatchDataAddWorkorder(txnId, wo);

will add the wo work order for the session context with the transaction ID determined by the txnID variable.

pccBatchDataBeginWorklogs

This function enables a list with work logs to be created for a session context. When this function has been called, the session context field in the UDR can be populated with the list of work logs.

Code Block
void pccBatchDataBeginWorklog ( long txnId )

Parameters

ParameterDescription

txnId

The transaction ID of the session context for which you want to create a list of work logs.


Info
titleExample


Code Block
pccBatchDataBeginWorklogs(cycle.TxnId);

will create a list of work logs for the session context with the transaction ID given in the TxnId field in the cycle UDR.

pccBatchDataAddWorklog

This function adds a work log to a session context.

Code Block
void pccBatchDataAddWorklog( long txnId, Worklog data )

Parameters

ParameterDescription

txnId

The transaction ID of the session context for which you want to add a work log.

data

The work

log

logs you want to add.


Info
titleExample


Code Block
pccBatchDataAddWorklog(txnId, wl);

will add the wl work order for the session context with the transaction ID determined by the txnID variable.

pccBatchDataAddWorklogs

This function adds a list of work logs to a session context. In the real-time template, this function is used for adding work logs for successfully updated work orders to the session context, for example.

Code Block
void pccBatchDataAddWorklogs( long txnId, List<Worklog> data )

Parameters

ParameterDescription

txnId

The transaction ID of the session context for which you want to add a list of work logs.

data

The list of work logs you want to add.


Info
titleExample


Code Block
pccBatchDataAddWorklogs(txnId, logs);

will add the logs list with work orders for the session context with the transaction ID determined by the txnID variable.

pccBatchDataSuspendWorklogs

This function will suspend the work logs for a session context, this may be useful in case of an abnormal stop, for example.

Code Block
void pccBatchDataSuspendWorklogs( long txnId )

Parameters

ParameterDescription

txnID

The transaction ID of the session context for which to suspend work logs.


Info
titleExample


Code Block
pccBatchDataSuspendWorklogs((long) mapGet(sc, S_TXNID));

will suspend the work logs for the session context with the transaction ID returned by the mapGet function.

pccBatchDataResumeWorklogs

Resumes the work logs for a session context. This functions function is used after the pccBatchDataSupsendWorklogs function has been called.

Code Block
void pccBatchDataResumeWorklogs( long txnId )

Parameters

ParameterDescription

txnID

The transaction ID of the session context for which to resume work logs.


Info
titleExample


Code Block
pccBatchDataResumeWorklogs(cycle.TxnId);

will resume the work logs for the session contexts with the transaction ID given in the TxnId field in the cycle UDR.

pccBatchDataGetWorkorders

This function retrieves a list with of work orders for a certain session context. In the real-time workflow template, this is used for retrieving the list of work orders to compare with the list of work logs, for example.

Code Block
list<Workorder> pccBatchDataGetWorkorders( long txnId )

Parameters

ParameterDescription

txnId

The transaction ID of the session context for which to retrieve a list with work orders.

Returns:

A list with work logs.


Info
titleExample


Code Block
list<Workorder> orders = pccBatchDataGetWorkorders(cycle.TxnId);

will return a list named orders containing the work orders for the session context with the transaction ID given in the TxnId field in the cycle UDR.

pccBatchDataWorklogs

This functions returns a list with work logs for a certain session context. In the real-time workflow template, this is used for retrieving the list of work logs to compare with the list of work orders, for example.

Code Block
list<Worklog> pccBatchDataGetWorklogs( long txnId )

Parameters

ParameterDescription

txnId

The transaction ID of the session context for which to retrieve a list with work logs.

Returns:

A list with work logs.


Info
titleExample


Code Block
list<Worklog> logs = pccBatchDataGetWorklogs(cycle.TxnId);

will return a list named logs containing the work logs for the session context with the transaction ID given in the TxnId field in the cycle UDR.

pccBatchDataRemove

This function removes the batch data for a session context. In the real-time workflow template, this function is used for removing all work orders and work logs that have been successfully validated, updated and compared.

Code Block
void pccBatchDataRemove( long >txnId )

Parameters

ParameterDescription

txnId

The transaction ID of the session context for which you want to remove the batch


Info
titleExample


Code Block
pccBatchDataRemove((long) mapGet(sc, S_TXNID));

will remove the batch data for the session context with the transaction ID returned by the mapGet function.

...