[vrotsc, vrotsc-annotations] (#337) Add Workflow canvas Scheduled Workflow item

[Michaelpalacce]

Description

@ScheduledWorkflowItem

The decorator is used to specify a scheduled workflow item that will be called.

Supported Parameters

• target - The name of the next in line item. Same as @Item.
• linkedItem - The ID of the workflow to schedule.

In order to bind inputs and outputs, you do it with the @In and @Out decorators. This is the same way we do it for other items.

Inputs

Special input is needed for the ScheduledWorkflowItem.

• workflowScheduleDate - {Date} is required. The name must be workflowScheduleDate. If this is missing an error is thrown. We don't check if the type is Date but Aria Orchestrator will complain.

Outputs

Special output is needed for the ScheduledWorkflowItem.

• scheduledTask - {Task} is optional. If it's missing nothing will happen, if it's added, then the name must be scheduledTask. This is the task that is scheduled.

import { Workflow, Out, In, Item, RootItem, DecisionItem, WaitingTimerItem, WorkflowItem, ScheduledWorkflowItem } from "vrotsc-annotations";

@Workflow({
	name: "Example Waiting Timer",
	path: "VMware/PSCoE",
	attributes: {
		waitingTimer: {
			type: "Date"
		},
		counter: {
			type: "number"
		},
		first: {
			type: "number"
		},
		second: {
			type: "number"
		},
		result: {
			type: "number"
		},
		workflowScheduleDate: {
			type: "Date"
		},
		scheduledTask: {
			type: "Task"
		}
	}
})
export class HandleNetworkConfigurationBackup {
	@DecisionItem({ target: "waitForEvent", else: "prepareItems" })
	public decisionElement(waitingTimer: Date) {
		return waitingTimer !== null;
	}

	@Item({ target: "callOtherWf" })
	public prepareItems(@In @Out first: number, @In @Out second: number, @In @Out workflowScheduleDate: Date) {
		first = 1;
		second = 2;
		workflowScheduleDate = System.getDate("1 minute from now", undefined);
	}

	@WorkflowItem({
		target: "print",
		linkedItem: "9e4503db-cbaa-435a-9fad-144409c08df0"
	})
	public callOtherWf(@In first: number, @In second: number, @Out result: number) {
	}


	@Item({ target: "scheduleOtherWf" })
	public print(@In result: number) {
		System.log("Result: " + result);
	}

	@ScheduledWorkflowItem({
		target: "printScheduledDetails",
		linkedItem: "9e4503db-cbaa-435a-9fad-144409c08df0"
	})
	public scheduleOtherWf(@In first: number, @In second: number, @In workflowScheduleDate: Date, @Out scheduledTask: Task) {
	}

	@Item({ target: "end" })
	public printScheduledDetails(@In scheduledTask: Task) {
		System.log(`Scheduled task: ${scheduledTask.id}, [${scheduledTask.state}]`);
	}

	@Item({ target: "decisionElement", exception: "" })
	public execute(@Out @In waitingTimer: Date, @Out @In counter: number): void {
		if (!counter) {
			counter = 0;
		}

		counter++;

		if (counter < 2) {
			const tt = Date.now() + 5 * 1000;
			waitingTimer = new Date(tt);
		} else {
			waitingTimer = null;
		}

		System.log("Counter: " + counter);
		System.log("Waiting Timer: " + waitingTimer);
	}

	@Item({ target: "execute", exception: "" })
	@RootItem()
	public start() {
		System.log("Starting workflow");
	}

	@WaitingTimerItem({ target: "execute" })
	public waitForEvent(@In waitingTimer: Date) {
	}
}

Will give the following:

Checklist

• I have added relevant error handling and logging messages to help troubleshooting
• I have added tests that prove my fix is effective or that my feature works
• I have added necessary documentation, relevant usage information (if applicable)
• I have updated the PR title with affected component, related issue number and a short summary of the changes introduced
• I have added labels for implementation kind (kind/) and version type (version/)
• I have tested against live environment, if applicable
• I have synced any structure and/or content vRA-NG improvements with vra-ng and ts-vra-ng archetypes (if applicable)
• I have my changes rebased and squashed to the minimal number of relevant commits. Notice: don't squash all commits
• I have added a descriptive commit message with a short title, including a Fixed #XXX - or Closed #XXX - prefix to auto-close the issue

Testing

e2e tests added to the pr and screenshots as proof it works

Fixed #337

[akantchev]

The itemInfo parameter should be optional (as in the interface it is optional).

[Michaelpalacce]

In the interface it should not be optional, will fix it

[akantchev]

It is a good idea to add JSDoc to each of the public methods.

[akantchev]

Please remove (probably leftover from the merge conflict).

[akantchev]

I see you didn't declare the exception parameter in the vro-types/vrotsc-annotations/index.d.ts nor you're handling it in the decorator. You should remove this case if you don't need to handle the exception parameter.